Skip to content

Commit 925afd6

Browse files
XylopyrographerXylopyrographer
authored
Merge pull request #40 from Xylopyrographer/v_1.10
Version 1.10
2 parents f72d45e + 54aac7e commit 925afd6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+559
-160
lines changed

‎Documentation/Peripheral Mode Application Note.md

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Peripheral Mode Application Note
2+
3+
As described in the *STAC User's Guide*, STAC software starting with version 1.10 adds a Peripheral Mode of operation.
4+
5+
This note goes into what happens behind the scenes with the STAC running a version of software that implements Peripheral Mode: during startup; when operating as a peripheral; and also when in its normal operating state.
6+
<br><br>
7+
8+
## Initiating Client Mode
9+
10+
A STAC is placed into Peripheral Mode by:
11+
12+
1. Placing a jumper wire between G22 and G33 on the ATOM rear header block.
13+
1. Applying power either via its USB port or a cable connecting its GROVE port to the GROVE port of another STAC. Do one or the other, not both.
14+
15+
When powered up or when reset, the STAC configures G22 as an output pin and G33 as an input pin (with weak pull down). It then toggles the state of G22 in a sequence and confirms that G33 follows. If G33 follows throughout the entire sequence, it is assumed the "Peripheral Mode jumper" is in place.
16+
17+
If G33 fails to follow G22 at any point during the sequence, the STAC assumes the jumper is not in place and it will start up in its normal operation state.
18+
19+
In either case G22 is then driven low.
20+
21+
After the STAC confirms the jumper is in place, it then configures G26 and G32 on its GROVE (HY2.0-4P) connector as input pins (with weak pull downs) and enters Peripheral Mode.
22+
<br><br>
23+
24+
## Operation in Peripheral Mode
25+
26+
In Peripheral Mode, all normal operation state and features of the STAC are disabled. The STAC will not connect to a WiFi network and it will ignore any Tally Channel, Operating Mode and Startup Mode settings. The Display Brightness select feature remains enabled as does the orientation feature so the Brightness Select numbers are displayed right side to.
27+
28+
In Peripheral Mode, the STAC continually monitors the state of G26 and G32 on its GROVE port and uses the state of those inputs to determine the state of its tally display as per the table below.
29+
30+
| G26 | G32 | DISPLAYED<br>TALLY STATE |
31+
|:---:|:---:|:---:|
32+
| 0 | 0 | PVW |
33+
| 0 | 1 | PVW |
34+
| 1 | 0 | PVW |
35+
| 1 | 1 | PGM |
36+
37+
**Where:**<br>
38+
&nbsp;&nbsp;&nbsp;**1** = logic high (true)<br>
39+
&nbsp;&nbsp;&nbsp;**0** = logic low (false)<br>
40+
&nbsp;&nbsp;&nbsp;**PVW** (Preview, Standby, Selected) = GREEN<br>
41+
&nbsp;&nbsp;&nbsp;**PGM** (Program, Live, On Air) = RED
42+
43+
Here's the cool part. This allows the opportunity for developers to use a STAC set in Peripheral Mode as a tally indicator driven by an external piece of gear. Simply connect a cable to the GROVE port, apply power and drive pins G26 and G32 as needed.
44+
45+
**Be aware that the ATOM Matrix GPIO pins use 3.3V logic levels and are not 5V tolerant.<br>Driving any GPIO pin beyond 3.3 V will irreparably damage the device.**
46+
<br><br>
47+
48+
## Normal State (Controller) Output Signals
49+
50+
Starting with software v1.10, a STAC running it its normal operating state (not in Peripheral Mode) also acts as a controller by outputting the current tally state of the video channel it is monitoring to its GROVE connector. Pins G26 and G32 on this port are set as per the table below.
51+
52+
| G26 | G32 | ROLAND SWITCH<br>TALLY STATE
53+
|:---:|:---:|:---:|
54+
| 0 | 0 | UNKNOWN |
55+
| 0 | 1 | UNSELECTED |
56+
| 1 | 0 | PVW |
57+
| 1 | 1 | PGM |
58+
59+
**Where:**<br>
60+
&nbsp;&nbsp;&nbsp;**1** = logic high (true)<br>
61+
&nbsp;&nbsp;&nbsp;**0** = logic low (false)<br>
62+
&nbsp;&nbsp;&nbsp;**UNKNOWN** = the STAC is not connected to the Roland switch; or no information was reported from the last poll; or the return from the last poll was not an expected response; or the STAC is in an error state.<br>
63+
&nbsp;&nbsp;&nbsp;**UNSELECTED** = the video channel being monitored is neither in PVW or PGM.<br>
64+
&nbsp;&nbsp;&nbsp;**PVW** = the channel being monitored is in preview (Preview, Standby, Selected)<br>
65+
&nbsp;&nbsp;&nbsp;**PGM** = the channel being monitored is in program (Program, Live, On Air)
66+
67+
This allows the opportunity for developers to use a STAC running in its normal state to provide tally information to another piece of gear.
68+
69+
To do this, connect a cable to the GROVE port, apply power and monitor the state of pins G26 and G32.
70+
71+
This could allow the STAC to:
72+
73+
- drive a larger or brighter indictor;
74+
- act as a wireless tally relay;
75+
- be integrated as an indicator and controller into a system such as [Tally Arbiter](http://www.tallyarbiter.com).
76+
77+
The "UNSELECTED" state is useful as it indicates normal operation and communication of the controller STAC with the Roland (or emulated) device being monitored even if that channel is not active in either PGM or PVW.
78+
79+
With proper cabling, multiple STACS operating in Peripheral Mode could be connected in parallel to a STAC operating in its normal state. No testing has been done to confirm how many STACs could be driven in this manner. Power supply would be an issue to consider as well.
80+
<br><br>
81+
82+
83+
## Disabling Client Mode
84+
85+
To disable Peripheral Mode and return the STAC it to its normal operating state:
86+
87+
1. Remove power from the Peripheral Mode STAC.
88+
1. Remove the GROVE cable connecting the STACs. **Do not** use the GROVE cable to power up two STAC's that are in their normal oprating state.
89+
1. Remove the Peripheral Mode jumper wire from the rear of the STAC.
90+
1. Power up the STAC via its USB port.
91+
92+
<br>
93+
94+
## Notes
95+
96+
1. **Be aware that the ATOM Matrix GPIO pins use 3.3V logic levels and are not 5V tolerant.<br>Driving any GPIO pin beyond 3.3V will irreparably damage the device.**
97+
1. The serial data dump on power up or restart when in Peripheral Mode (see the *Using screen for STAC Information.md* document) will report that the STAC is in Peripheral Mode and the brightness level set.
98+
1. The *Peripheral Mode* section of the *User's Guide* provides more information on the GROVE cable.
99+
<br><br>
100+
101+
---
102+
103+
## Document Revision History
104+
105+
**2022-01-04:** First release.<br>

‎Release Notes.md ‎Documentation/Release Notes.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
# STAC Release Notes
2+
## v1.10
3+
4+
__New Features__
5+
6+
* _Adds Peripheral Mode_
7+
* Allows one STAC to be connected to another via their GROVE ports. The STAC configured in Peripheral Mode operates as if in Talent Mode but it receives its tally information from the connected STAC without the need to establish a WiFi connection to the Roland device. More in the *STAC User's Guide* and the *Peripheral Mode Application Note*.
8+
9+
* _Adds Configuration Check_
10+
* Previously, the configuration of the STAC would be reset with each software update. After updating to version 1.10 you will have to reconfigure the STAC but from then on new software updates will do a check to see if the existing configuration is compatible with that version. If so, the existing configuration information will be retained. Too cool 🤯.
11+
12+
13+
214
## v1.9.1
315

416
__Fixes__

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

File renamed without changes.

‎STAC/Using screen for STAC Information.md ‎Documentation/Using screen for STAC Information.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ To view this, you need an application on your computer that can take in serial d
66

77
macOS, through its Terminal app supports the `screen` serial monitor app which can be used to view this startup information.
88

9-
Terminal commands to connect to a STAC.
9+
**To use `screen` to receive information from a STAC:**
1010

1111
1. Open the Terminal app on your Mac.
1212
1. Connect the STAC to a USB port.
13-
1. In terminal, find the STAC serial address by typing:
13+
1. In Terminal, find the STAC serial address by typing:
1414
`ls /dev/cu.usbserial*`
15-
1. Look for a line like: `/dev/cu.usbserial-3552F606F3`
16-
1. Select and copy the above.
17-
1. In the Terminal window, type `screen ` and then paste in the line from above and then type `115200`. <br>The complete line should look something like this:<br>
15+
1. In the list that is returned, look for a line like:<br>`/dev/cu.usbserial-3552F606F3`
16+
1. Select and copy the above line.
17+
1. In the Terminal window, type: `screen`; a space; then paste in the line from above; and then type `115200`.<br>The complete line should look something like this:<br>
1818
`screen /dev/cu.usbserial-3552F606F3 115200`
1919
1. Hit the return key.
2020
1. Restart the STAC.
@@ -29,7 +29,7 @@ Something like:
2929
by: Team STAC
3030
https://github.com/Xylopyrographer/STAC
3131
32-
Software Version: 1.9.1
32+
Software Version: 1.10
3333
Configuration SSID: STAC_78B5927E
3434
Configuration IP: 192.168.6.14
3535
------------
@@ -44,20 +44,26 @@ https://github.com/Xylopyrographer/STAC
4444
======================================
4545
4646
```
47-
If the STAC has not been configured, it'll tell you that. And let you know when it's waiting for the configuration data. Then once configured, it'll send the rest of the information.
47+
If the STAC has not been configured, it'll tell you that. And it will let you know when it's waiting for the configuration data. Then once configured, it'll send the rest of the information.
48+
49+
If it is operting in Peripheral Mode, it'll also send that info out.
50+
51+
When doing a Factory Reset, it'll send out information to let you know how that's progressing.
4852

4953
You can select and copy this information to paste into another application.
5054

51-
To quit `screen`:
55+
**To quit `screen`:**
5256

53-
1. In the Terminal window, hold down the `control` and `A` key and then the `\` key.
54-
1. Confirm you want to quit by typing 'y'.
57+
1. In the Terminal window, while holding down the `control` key, type `a` then `\`.
58+
1. A prompt will pop up at the bottom of the screen. Release the `control` key. Confirm you want to quit by typing `y`.
5559
1. Quit the Terminal app.
5660

57-
If you see a bunch of garbage on the screen after typing the `screen` command, or the screen command gives an error message, ensure that:
61+
**Note:**<br>
62+
If you see a bunch of garbage on the screen after typing the `screen` command, or the `screen` command gives an error message, ensure that:
5863

5964
* the `/dev/...` line was copied and pasted correctly;
6065
* there are no extra spaces in the command line;
6166
* the last thing on the line is exactly `115200`.
6267

6368
Computers are fussy that way.
69+

0 commit comments

Comments
 (0)