Skip to content

Commit

Permalink
📃 Updated documentation; 🎨 Added margin to select fields and removed …
Browse files Browse the repository at this point in the history
…margin on Save button
  • Loading branch information
guido-visser committed Oct 17, 2020
1 parent 8d82b0a commit 47c4ce9
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 15 deletions.
96 changes: 84 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,24 @@

## Features

- âš¡ Press on M5 button will toggle between 4 screens:
- 🚀 Press on M5 button will toggle between 4 screens:
1. The actual status of the tally (a tally status change will default back to this screen)
2. Network screen, showing the current IP Address so you can access the Web UI
3. Show the actual tally input number that is set for the unit
4. The brightness screen. You can use BTN39 on this screen to toggle through the 9 different settings
- âš¡ Webserver for easy configuration
- âš¡ Access Point mode when not connected to a WiFi network
- âš¡ Data is saved to memory, will be remembered after device is turned off
- âš¡ Dedicated button to reconnect to vMix (BTN39, will reconnect to vMix except on the brightness screen)
- âš¡ Holding the same button at the end of trying to reconnect will reset the settings
- âš¡ Dark Web UI
- âš¡ Ability to adjust the brightness (either on the stick itself, or via the Web UI)
- âš¡ Battery indicator
- âš¡ Landscape & Portrait mode using accelerometer
- âš¡ Change tally number input on the fly. On the tally input number screen, double click the BTN39 to increase the number. Long click for reset to 1
- âš¡ Multi input support
- 🚀 Webserver for easy configuration
- 🚀 Access Point mode when not connected to a WiFi network
- 🚀 Data is saved to memory, will be remembered after device is turned off
- 🚀 Dedicated button to reconnect to vMix (BTN39, will reconnect to vMix except on the brightness screen)
- 🚀 Holding the same button at the end of trying to reconnect will reset the settings
- 🚀 Dark Web UI
- 🚀 Ability to adjust the brightness (either on the stick itself, or via the Web UI)
- 🚀 Battery indicator
- 🚀 Landscape & Portrait mode using accelerometer
- 🚀 Change tally number input on the fly. On the tally input number screen, double click the BTN39 to increase the number. Long click for reset to 1
- 🚀 Multi input support
- 🚀 Automatic wifi scanning to easily select your wifi network
- 🚀 Set an interval to automatically reconnect to vMix after the interval has passed

---

Expand Down Expand Up @@ -70,6 +72,76 @@ Enjoy 😄
4. Hit the save button.
5. The stick will restart with the given information.

### Fields explained
**SSID**

A select dropdown which shows a list all the wifi networks found.

**Hidden SSID Name**

This field only shows when you select `Hidden network` in the SSID list.
Type in the SSID that you want to connect to.

**Password**

The password that corresponds to the selected wifi network.

**vMix IP Address**

Fill in the IP Address of the computer where vMix is running.

How to find the IP of the vMix PC:
1. Press Win + R
2. Type in `cmd` and hit enter. A commandprompt will appear
3. In the commandprompt type `ipconfig` and press enter
4. Your IP Address can be found behind the `IPv4 Address. . . . . . . . . . . : ` line

**Main Tally Number**

This field corresponds to the input number in vMix. Every input has a number in the top left corner of the video tile. Enter the input number you want the tally to respond to.

**Multi Input**

It's possible to have more inputs hooked into 1 tally light, you can provide a comma separated string to set this up.

Example:

When the Main Tally Number is set to `1` and Multi Input is set to `2,5`, this will be the behavior:

SAFE:

None of the inputs are in Preview or in the Program feed.

PRE:

One of the inputs is in Preview, none are on Program.

LIVE:

One of the inputs is on the Program feed. Live always has the highest priority.

**Reconnect interval**

Input is in seconds. This will try to reconnect to vMix every `x` seconds after the interval has passed when it's disconnected. This will loop if the connection cannot be established.

WARNING:
Since the stick is single threaded, when the stick tries to reconnect to vMix, the Web UI is not accessible!

Example:
When set to `10` it will try to reconnect to vMix every 10 seconds after connection was unsuccessful.

**Brightness**

Set the brightness of the LCD. Option to choose from:
* 0%
* 20%
* 40%
* 60%
* 80%
* 100%

NOTE: Obviously, the battery will drain faster when the brightness is set to a high value. I recommend setting it at 60%.

---

## Plugins
Expand Down
2 changes: 1 addition & 1 deletion src/a_GLOBAL/f_WEBSERVER.ino
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ String HEADER = "<!DOCTYPE html>\
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, shrink-to-fit=no'>\
<title>vMix M5Stick-C Tally</title>\
<style>\
@import url(https://fonts.googleapis.com/css2?family=Open+Sans&display=swap);.wrapper,input[type=text],input[type=number],input[type=submit],select{width:100%;box-sizing:border-box}body,html{background:#2b2b2b;color:#eee;padding:0;margin:0;font-family:'Open Sans',verdana,sans-serif}.wrapper{padding:10px}.wrapper h1{text-align:center}input[type=text],input[type=number]{margin-bottom:10px}input,select{background-color:#6d6d6d;color:#f0f0f0;border:1px solid #000;font-size:18px;height:35px;padding:0 5px}input[type=submit]{height:50px;margin:10px auto}@media screen and (min-width:600px){.wrapper{width:600px;margin:0 auto}}\
@import url(https://fonts.googleapis.com/css2?family=Open+Sans&display=swap);.wrapper,input[type=text],input[type=number],input[type=submit],select{width:100%;box-sizing:border-box}body,html{background:#2b2b2b;color:#eee;padding:0;margin:0;font-family:'Open Sans',verdana,sans-serif}.wrapper{padding:10px}.wrapper h1{text-align:center}input[type=text],input[type=number],select{margin-bottom:10px}input,select{background-color:#6d6d6d;color:#f0f0f0;border:1px solid #000;font-size:18px;height:35px;padding:0 5px}input[type=submit]{height:50px;margin:0 auto}@media screen and (min-width:600px){.wrapper{width:600px;margin:0 auto}}\
</style>\
</head>\
<body>\
Expand Down
4 changes: 2 additions & 2 deletions src/a_GLOBAL/webui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.wrapper h1{
text-align:center
}
input[type=text],input[type=number]{
input[type=text],input[type=number],select{
margin-bottom: 10px;
}
input, select{
Expand All @@ -34,7 +34,7 @@
padding: 0 5px;
}
input[type=submit]{
height: 50px;margin:10px auto;
height: 50px;margin:0 auto;
}
@media screen and (min-width: 600px) {
.wrapper{
Expand Down

0 comments on commit 47c4ce9

Please sign in to comment.