Skip to content

Commit 1700e72

Browse files
nseidlenseidle
authored
Merge pull request #489 from LeeLeahy2/led-update
Update the LED documentation
2 parents a93ef6a + 21a467b commit 1700e72

File tree

1 file changed

+140
-12
lines changed

1 file changed

+140
-12
lines changed

‎docs/led_states.md‎

Lines changed: 140 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,154 @@
11
# LED States
22

3-
A variety of LEDs are visible on the LoRaSerial radio to give the user feedback about the state of the system.
3+
A variety of LEDs are visible on the LoRaSerial radio to give the user feedback about the state of the system.
44

55
![LEDs on the LoRaSerial](img/SparkFun_LoRaSerial_LEDs.png)
66

77
*LEDs on the LoRaSerial*
88

9-
## LED Mode 1
9+
First lets define the LEDs on the LoRaSerial device. The following diagram shows the various LEDs:
1010

11-
In the default mode (selectedLedUse = 1):
11+
Antenna Qwiic
12+
+---------------------------+
13+
| |
14+
| G4 G3 G2 G1 |
15+
| |
16+
| |
17+
| Red |
18+
| |
19+
| |
20+
| Blue Yellow |
21+
| |
22+
+---------------------------+
23+
USB Serial
1224

13-
* The RSSI LEDs indicate the signal strength of the last received packet.
25+
The red LED is the power indicator. G1 through G4 in the diagram above are all green LEDs.
26+
27+
The LED behavior may be changed by using the AT-SelectLedUse command and setting the value to one of the mode numbers described in the sections below. As an example, if the radio is in multipoint mode the following serial data sequence causes the LEDs to display more information about the radio behavior.
28+
29+
+++
30+
AT-SelectLedUse=0
31+
ATO
32+
33+
## LED Mode 0 (LEDS_MULTIPOINT)
34+
35+
When the radio is in multipoint mode, selecting this mode for the LEDs provides additional insight into the radio's behavior.
36+
37+
* The G4 LED pulses when the radio transmits a frame.
38+
* The G3 LED is pulse width modulated to indicate the last received RSSI level.
39+
* The G2 LED turns on when the link is up (data can pass).
40+
* The G1 LED pulses when the radio successfully receives a frame.
41+
* The blue LED pulses on the server radio when the server transmits a HEARTBEAT frame. The blue LED pulses on the client radio when the client successfully receives a HEARTBEAT frame from the server.
42+
* The yellow LED pulses each time a channel hop (frequency change) occurs.
43+
44+
## LED Mode 1 (Default: LEDS_P2P)
45+
46+
When the radio is in point-to-point mode, selecting this mode for the LEDs provides additional insight into the radio's behavior.
47+
48+
* The G4 LED pulses when the radio transmits a frame.
49+
* The G3 LED is pulse width modulated to indicate the last received RSSI level.
50+
* The G2 LED is off.
51+
* The G1 LED pulses when the radio successfully receives a frame.
52+
* The blue LED pulses on the radio successfully receives a HEARTBEAT frame.
53+
* The yellow LED pulses each time a channel hop (frequency change) occurs.
54+
55+
## LED Mode 2 (LEDS_VC)
56+
57+
When the radio is in virtual-circuit mode, selecting this mode for the LEDs provides additional insight into the radio's behavior.
58+
59+
* The G4 LED pulses when the radio transmits a frame.
60+
* The G3 LED is pulse width modulated to indicate the last received RSSI level.
61+
* The G2 LED pulses when serial data is received.
62+
* The G1 LED pulses when the radio successfully receives a frame.
63+
* The blue LED pulses on the server radio when the server transmits a HEARTBEAT frame. The blue LED pulses on the client radio when the client successfully receives a HEARTBEAT frame from the server.
64+
* The yellow LED pulses each time a channel hop (frequency change) occurs.
65+
66+
## LED Mode 3 (LEDS_RADIO_USE)
67+
68+
This mode is useful for users who want additional LED feedback about the RF link.
69+
70+
* The G4 LED pulses when the radio transmits a frame.
71+
* The G3 LED is pulse width modulated to indicate the last received RSSI level.
72+
* The G2 LED turns on when the link is up (data can pass).
73+
* The G1 LED pulses when the radio successfully receives a frame.
74+
* The blue LED will blink when the radio receives a bad frame.
75+
* The yellow LED will blink when the radio receives a duplicate frame or receives frame where the software CRC does not match.
76+
77+
## LED Mode 4 (Default: LEDS_RSSI)
78+
79+
In the Received Signal Strength Indicator (RSSI) mode uses the green LEDs to indicate ranges of signal strengths:
80+
81+
* The RSSI LEDs indicate the signal strength of the last received packet:
82+
* -70 < RSSI: All green LEDs lit (strong)
83+
* -100 < RSSI <= -70: G3, G2, G1 LEDs lit, G4 off
84+
* -120 < RSSI <= -100: G2, G1 LEDs lit, G4 and G3 off
85+
* -150 < RSSI <= -120: G1 LED lit, all G4, G3 and G2 off (weak)
86+
* RSSI <= -150: <= All green LEDs off
1487
* The blue TX LED indicates when serial data is received over the radio and sent to the host, either over USB or hardware serial.
1588
* The yellow RX LED indicates when serial data is received from the host and sent over the radio.
1689

17-
## LED Mode 2
90+
## LED Mode 5 (LEDS_BUTTON_PRESS)
91+
92+
The button press mode is an internal mode used to indicate the state of the button press. The green LEDs are counting seconds. The following blue and yellow LED behavior occurs:
93+
94+
* Press time < 4 seconds: Blue LED is off and if in command mode or not performing training the yellow LED is off. Otherewise if not in command mode and performing training the yellow LED is flashing and upon button release the radio exits training.
95+
96+
* 4 seconds <= button press time < 8 seconds: Yellow LED is off and if in command mode or not performing training the blue LED is off. Otherewise if not in command mode and performing training the blue LED is flashing and upon button release the radio enters training in client mode.
97+
98+
* 8 seconds <= button press time < 16 seconds: If in command mode or not performing training both LEDs are off. Otherewise if not in command mode and performing training the both LEDs are flashing and upon button release the radio enters training in server mode.
99+
100+
* 16 seconds <= button press time: Reset pattern caused by a system reset
101+
102+
## LED Mode 7 (LEDS_CYLON)
103+
104+
The cylon eye pattern in green is typically used to indicate radio training. One green LED is lit at a time and the lit LED moves from side to side.
105+
106+
G4 G3 G2 G1
107+
X
108+
X
109+
X
110+
X
111+
X
112+
X
113+
X
114+
X
115+
...
116+
117+
* The blue LED will blink when the radio transmits a frame.
118+
* The yellow LED will blink when the radio successfully receives a frame.
119+
120+
## LED Mode 8 (LEDS_ALL_OFF)
121+
122+
This is a testing pattern with all LEDs off.
123+
124+
## LED Mode 9 (LEDS_BLUE_ON)
125+
126+
This is a testing pattern with only the blue LED on.
127+
128+
## LED Mode 10 (LEDS_YELLOW_ON)
129+
130+
This is a testing pattern with only the yellow LED on.
131+
132+
## LED Mode 11 (LEDS_GREEN_1_ON)
133+
134+
This is a testing pattern with only the G1 LED on.
135+
136+
## LED Mode 12 (LEDS_GREEN_2_ON)
137+
138+
This is a testing pattern with only the G2 LED on.
139+
140+
## LED Mode 13 (LEDS_GREEN_3_ON)
141+
142+
This is a testing pattern with only the G3 LED on.
143+
144+
## LED Mode 14 (LEDS_GREEN_4_ON)
145+
146+
This is a testing pattern with only the G4 LED on.
147+
148+
## LED Mode 15 (LEDS_ALL_OFF)
149+
150+
This is a testing pattern with all LEDs on.
18151

19-
For users who want additional LED feedback about the RF link, setting selectedLedUse to 2 has the following effects:
152+
## Other LED modes
20153

21-
* The blue LED will blink any time a heartbeat is received.
22-
* The yellow LED will blink when a channel hop occurs.
23-
* The 1st RSSI LED from the top indicates data is being transmitted.
24-
* The 2nd RSSI LED from the top turns on when the link is up (data can pass).
25-
* The 3rd RSSI LED from the top indicates the last received RSSI.
26-
* The 4th RSSI LED from the top indicates data being successfully received.
154+
Undefined LED modes display the RSSI pattern (mode 4).

0 commit comments

Comments
 (0)