Skip to content

Commit e1521dd

Browse files
XylopyrographerXylopyrographer
authored
Merge pull request #8 from Xylopyrographer/speed
Baseline for software version 1.7.1
2 parents 9e7d2af + ac1bae5 commit e1521dd

13 files changed

+734
-179
lines changed

‎README.md

+16-25
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# STAC
2-
## (Smart Tally Atom Client)
3-
**A Roland Smart Tally Client**
1+
# STAC
2+
## (Smart Tally Atom Client)
3+
**A Roland Smart Tally Client**
44

5-
This is an Arduino sketch designed to run on an [M5Stack ATOM Matrix](https://docs.m5stack.com/#/en/core/atom_matrix) board.
5+
An Arduino sketch designed to run on an [M5Stack ATOM Matrix](https://docs.m5stack.com/#/en/core/atom_matrix) board.
66

77
Its purpose is to monitor the tally status of a single video input channel
88
of a Roland video device that implements their proprietary Smart Tally protocol.
@@ -23,32 +23,23 @@ the colour of the display on the ATOM:
2323
Configuration of the STAC for the WiFi credentials and IP address, port number
2424
and number of tally channels of the Roland switch is done using a web browser.
2525

26-
When in its Configuration state the:
26+
Lots of good information in the *STAC User Guide*, located in the `manual` folder.
2727

28-
* STAC WiFi SSID is:
29-
* **STAC_XXXXXXXX**
30-
where the X's are a set of characters unique to every ATOM unit.
28+
There are other good bits you'll want to read in the `STAC` folder.
3129

32-
* Password is:
33-
* **1234567890**
34-
35-
* STAC configuration page is at:
36-
* **192.168.6.14**
37-
38-
39-
To use this sketch:
30+
## To use this sketch:
4031

4132
* download the zip file from the **Code** tab
42-
* unzip the STAC-main.zip file
43-
* rename the unzipped folder from *STAC-main* to just *STAC*
44-
* move the *STAC* folder to your Arduino sketch folder.
45-
46-
Use of this sketch requires a modified set of libraries. See the *library_README.md* file in the *library* folder.
47-
48-
Additional information is in the User Manual, located in the *manual* folder.
33+
* unzip the `STAC-main.zip` file
34+
* rename the unzipped folder from `STAC-main` to just `STAC`
35+
* move the `STAC` folder to your Arduino sketch folder.
4936

37+
|Use of this sketch requires a modified set of libraries. <br>See the`libraries_README.md` file in the `libraries` folder.|
38+
:---:
39+
<br><br>
5040
---
5141

52-
## Revision History
42+
### Document Revision History
5343

54-
**2021-04-05:** Revise for user configurable port number
44+
**2021-04-07:** Delete config info. Minor format changes.
45+
**2021-04-05:** Revise for user configurable port number.

‎STAC Communications.md ‎STAC/STAC Communications.md

+17-7
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,48 @@
44

55
Short techie document describing the way a STAC communicates with a Roland device using the Smart Tally protocol.
66

7-
This is only relevant if you are using a STAC in an emulated environment. That is where the STAC is not communicating with a physical Roland device but is operating in a system that emulates a Roland device, using the Smart Tally protocol.
7+
This is only relevant if you are using a STAC in an emulated environment. That is, where the STAC is not communicating with a physical Roland device but is operating in a system that emulates a Roland device using the Smart Tally protocol.
88

99
## Initiation
1010

11-
When using a smart device or computer with a full browser implementation, the initial connection sequence to the Roland switch via that devices' web browser will cause the Roland switch to send a web page containing a set of scripts used by the browser allowing the user to select a specific tally channel to monitor and for subsequent status requests to the Roland switch.
11+
When using a smart device or computer with a full browser implementation, the initial connection sequence to the Roland switch via that devices' web browser will cause the Roland switch to send a web page containing a set of scripts used by the browser allowing the user to select a specific tally channel to monitor and then for subsequent status requests to the Roland switch.
1212

13-
The STAC, having no capacity to run the scripts sent by the Roland switch, bypasses that initial initialization sequence. It instead establishes a connection to the Roland switch and them immediately starts to poll the Roland switch for the tally status of the channel selected by the user during setup of the STAC.
13+
The STAC, having no capacity to run the scripts sent by the Roland switch, bypasses that initial initialization sequence. It instead establishes a connection to the Roland switch and then immediately starts to poll the Roland switch for the tally status of the channel selected by the user during setup of the STAC.
1414

15-
## STAC Status Inquiry
15+
## Status Request
1616

1717
When operating, the STAC continuously polls the Roland switch by sending to it an ASCII character string in the following format:
1818

1919
`GET /tally/[number]/status`
2020
followed by a `<return>` and a `<newline>` character.
2121

22-
Here, `[number]` is the ASCII integer representation of tally channel number of the Roland device for which status is being requested, `1` to `8`.
22+
Where: `[number]` is the ASCII integer representation of the tally channel number of the Roland device for which status is being requested; `1` to `8`.
2323

2424
This string is sent to the IP address and port number specified by the user when the STAC is configured via a web browser. Refer to the *STAC Users Guide.md* in this repository.
2525

2626
## Expected Response
2727

28-
The STAC is expecting a response to a status inquiry to be an ASCII character string that is exactly one of:
28+
The STAC is expecting a response to a status request to be an ASCII character string that is exactly one of:
2929

3030
`onair`
3131
`selected`
3232
`unselected`
3333

34-
With no `<return>` or `<newline>` characters added.
34+
With no `<return>` or `<newline>` characters appended.
35+
36+
Capitalization is significant.
3537

3638
Any other response will cause the STAC to display an error state as described in the *Troubleshooting* section of the *STAC Users Guide.md*.
3739

40+
## Other Considerations
41+
42+
The STAC send no identifiable information directly in the status request. Thus in emulated environments, using the requested tally channel number as a STAC identifier may limit the number of physical STACs that can be used.
43+
44+
Other methods, such as using the MAC address or IP address assigned to a STAC from the router, may be considered.
45+
3846
---
3947
### Revision History
48+
**2021-04-08:** Add "Other Considerations" section. Correct typos.
4049
**2021-04-05:** First release.
4150

51+

‎STAC/STAC Release Notes.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# STAC Release Notes
2+
3+
## 1.7.1
4+
- improve the ST server poll response time by about a gazillion. As a result...
5+
- ...the ST\_POLL\_INTERVAL now does indeed govern the time between ST server polls
6+
- add an information dump to the serial port on startup
7+
8+
## 1.7
9+
- add support for user configurable ST Server port #.
10+
- Allows STAC to be used in an emulated environment; as in a [Tally Arbiter](http://www.tallyarbiter.com) client
11+
12+
## 1.6
13+
- first public release

0 commit comments

Comments
 (0)