Skip to content

Commit f0bc305

Browse files
authored
Merge pull request #780 from Jocke4f/fix_build_m5stickc-listener
Refactor building for different m5stickc boards
2 parents 7d5ba26 + be89ed1 commit f0bc305

File tree

3 files changed

+313
-257
lines changed

3 files changed

+313
-257
lines changed

Diff for: docs/docs/usage/control-interface.md

+2-14
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,10 @@ All the changes you make there are saved to a `config.json` file. This file shou
1818

1919
- Windows: `C:\Users\YourUsername\AppData\Roaming\TallyArbiter\config.json`
2020
- MacOS: `~/Library/Preferences/TallyArbiter/config.json`
21-
- Linux: `~/.local/share/TallyArbiter/config.json`
21+
- Linux: `~/.local/share/TallyArbiter/config.json` or `/root/.local/share/TallyArbiter/config.json` (when using sudo)
2222

2323
You can also manually edit that file.
2424

2525
**Make sure that TallyArbiter is closed while making changes, because otherwise they will be overwritten!**
2626

27-
You can change the security of the settings and the producer page by adding or replacing the following section to your `config.json` file:
28-
29-
```javascript
30-
{
31-
"security":
32-
{
33-
"username_settings": "admin",
34-
"password_settings": "12345",
35-
"username_producer": "producer",
36-
"password_producer": "12345"
37-
}
38-
}
39-
```
27+
On the settings page can the settings be exported/imported to/from a file via the configuration interface.

Diff for: listener_clients/m5stickc-listener/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ https://www.adafruit.com/product/4290 (Shipped from USA)
2828
You should select the file that ends in **.ino.bin**, not the file that ends in _.ino.elf_ or _.ino.partitions.bin_.
2929
5. Flash the firmware on your board _(clicking "Flash ESP" in esphome-flasher)_.
3030

31+
**NB:** The built version onf GitHub is only for **M5StickC**.
32+
3133
Done! Now your board is running the latest listener client firmware version. Go to the _"Setup your device"_ sections to connect the board to the Tally Arbiter server.
3234

3335
## 2. Using the Arduino IDE
@@ -41,7 +43,12 @@ Done! Now your board is running the latest listener client firmware version. Go
4143

4244
Done! Now your board is running the latest listener client firmware version. Go to the _"Setup your device"_ sections to connect the board to the Tally Arbiter server.
4345

44-
NB: The code base is either compiled for **M5StickC**, **M5StickC-Plus** or **M5StickC-Plus2** based on the configured **board** in **Arduino IDE**. Only one can be enabled at at time.
46+
The code base is compiled for **M5StickC**, **M5StickC-Plus** or **M5StickC-Plus2** based on the configured **M5Stack Arduino** version in **Board** in Arduino IDE. Only one can be enabled at at time:
47+
- M5Stack Arduino -> M5StickC
48+
- M5Stack Arduino -> M5StickC-Plus
49+
- M5Stack Arduino -> M5StickC-Plus2
50+
51+
It is possible to manually select what board type to build for if the wanted board type in the ino file, e.g., when not using Arduino IDE.
4552

4653
TALLY_EXTRA_OUTPUT can be used for extra tally info. The internal led is used for program. Preview and aux is available on external ports by default.
4754

0 commit comments

Comments
 (0)