Docs: Update LED states. Update mkdocs config.

nseidle · nseidle · commit 7278efc520c4 · 2023-02-22T12:22:15.000-07:00
diff --git a/docs/hardware_overview.md b/docs/hardware_overview.md
@@ -112,7 +112,7 @@ For security reasons, the radios are both set to the lowest transmission power t
 
 The firmware on the LoRaSerial can be upgraded from a computer without ever having to open the unit. In the rare case that the SAMD21 needs to be forced into bootloader mode the reset button should be quickly double-tapped. The unit will then enter bootloader mode and wait for new firmware or for a reset event (button is pressed or power is cycled).
 
-Please see [Updating LoRaSerial Firmware](docs\firmware_update.md) for more information.
+Please see [Updating LoRaSerial Firmware](http://docs.sparkfun.com/SparkFun_LoRaSerial/firmware_update/) for more information.
 
 ### GPIO
 
diff --git a/docs/img/SparkFun_LoRaSerial_LEDs.png b/docs/img/SparkFun_LoRaSerial_LEDs.png
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/led_states.md b/docs/led_states.md
@@ -6,7 +6,7 @@ A variety of LEDs are visible on the LoRaSerial radio to give the user feedback
 
 *LEDs on the LoRaSerial*
 
-First lets define the LEDs on the LoRaSerial device.  The following diagram shows the various LEDs:
+The following diagram shows the various LEDs on the LoRaSerial device:
 
         Antenna         Qwiic
     +---------------------------+
@@ -22,86 +22,15 @@ First lets define the LEDs on the LoRaSerial device.  The following diagram show
     +---------------------------+
         USB            Serial
 
-The red LED is the power indicator.  G1 through G4 in the diagram above are all green LEDs.
+The red LED is the power indicator. G1 through G4 in the diagram above are all green LEDs.
 
-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.
+## Radio Reset
 
-    +++
-    AT-SelectLedUse=0
-    ATO
-
-## LED Mode 0 (LEDS_MULTIPOINT)
-
-When the radio is in multipoint mode, selecting this mode for the LEDs provides additional insight into the radio's behavior.
-
-* The G4 LED pulses when the radio transmits a frame.
-* The G3 LED is pulse width modulated to indicate the last received RSSI level.
-* The G2 LED turns on when the link is up (data can pass).
-* The G1 LED pulses when the radio successfully receives a frame.
-* 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.
-* The yellow LED pulses each time a channel hop (frequency change) occurs.
-
-## LED Mode 1 (Default: LEDS_P2P)
-
-When the radio is in point-to-point mode, selecting this mode for the LEDs provides additional insight into the radio's behavior.
-
-* The G4 LED pulses when the radio transmits a frame.
-* The G3 LED is pulse width modulated to indicate the last received RSSI level.
-* The G2 LED is off.
-* The G1 LED pulses when the radio successfully receives a frame.
-* The blue LED pulses on the radio successfully receives a HEARTBEAT frame.
-* The yellow LED pulses each time a channel hop (frequency change) occurs.
-
-## LED Mode 2 (LEDS_VC)
-
-When the radio is in virtual-circuit mode, selecting this mode for the LEDs provides additional insight into the radio's behavior.
-
-* The G4 LED pulses when the radio transmits a frame.
-* The G3 LED is pulse width modulated to indicate the last received RSSI level.
-* The G2 LED pulses when serial data is received.
-* The G1 LED pulses when the radio successfully receives a frame.
-* 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.
-* The yellow LED pulses each time a channel hop (frequency change) occurs.
-
-## LED Mode 3 (LEDS_RADIO_USE)
-
-This mode is useful for users who want additional LED feedback about the RF link.
-
-* The G4 LED pulses when the radio transmits a frame.
-* The G3 LED is pulse width modulated to indicate the last received RSSI level.
-* The G2 LED turns on when the link is up (data can pass).
-* The G1 LED pulses when the radio successfully receives a frame.
-* The blue LED will blink when the radio receives a bad frame.
-* The yellow LED will blink when the radio receives a duplicate frame or receives frame where the software CRC does not match.
-
-## LED Mode 4 (Default: LEDS_RSSI)
-
-In the Received Signal Strength Indicator (RSSI) mode uses the green LEDs to indicate ranges of signal strengths:
-
-* The RSSI LEDs indicate the signal strength of the last received packet:
-    * -70 < RSSI: All green LEDs lit (strong)
-    * -100 < RSSI <= -70: G3, G2, G1 LEDs lit, G4 off
-    * -120 < RSSI <= -100: G2, G1 LEDs lit, G4 and G3 off
-    * -150 < RSSI <= -120: G1 LED lit, all G4, G3 and G2 off (weak)
-    * RSSI <= -150: <= All green LEDs off
-* The blue TX LED indicates when serial data is received over the radio and sent to the host, either over USB or hardware serial.
-* The yellow RX LED indicates when serial data is received from the host and sent over the radio.
-
-## LED Mode 5 (LEDS_BUTTON_PRESS)
-
-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:
-
-* 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.
-
-* 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.
-
-* 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.
+When the device is first powered on or is reset, all LEDs will blink quickly three times indicating system reset.
 
-* 16 seconds <= button press time: Reset pattern caused by a system reset
+## Training
 
-## LED Mode 7 (LEDS_CYLON)
-
-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.
+During Training, the green RSSI LEDs will cylon back and forth. One green LED is lit at a time and the lit LED moves from side to side.
 
     G4    G3    G2    G1
                        X
@@ -114,41 +43,45 @@ The cylon eye pattern in green is typically used to indicate radio training.  On
                  X
           ...
 
-* The blue LED will blink when the radio transmits a frame.
-* The yellow LED will blink when the radio successfully receives a frame.
-
-## LED Mode 8 (LEDS_ALL_OFF)
-
-This is a testing pattern with all LEDs off.
-
-## LED Mode 9 (LEDS_BLUE_ON)
-
-This is a testing pattern with only the blue LED on.
+Once training is complete, the radio will reset causing all LEDS to blink.
 
-## LED Mode 10 (LEDS_YELLOW_ON)
+## LED Mode - LEDS_RSSI (4)
 
-This is a testing pattern with only the yellow LED on.
+This is the default mode. The RSSI LEDs will indicate the link's signal strength.
 
-## LED Mode 11 (LEDS_GREEN_1_ON)
+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, the following commands cause the LEDs to display different information about the radio's behavior.
 
-This is a testing pattern with only the G1 LED on.
-
-## LED Mode 12 (LEDS_GREEN_2_ON)
-
-This is a testing pattern with only the G2 LED on.
-
-## LED Mode 13 (LEDS_GREEN_3_ON)
+    +++
+    AT-SelectLedUse=4
+    ATO
 
-This is a testing pattern with only the G3 LED on.
+* The RSSI LEDs indicate the signal strength of the last received packet:
+    * -70 < RSSI: All green LEDs lit (strong)
+    * -100 < RSSI <= -70: G3, G2, G1 LEDs lit, G4 off
+    * -120 < RSSI <= -100: G2, G1 LEDs lit, G4 and G3 off
+    * -150 < RSSI <= -120: G1 LED lit, all G4, G3 and G2 off (weak)
+    * RSSI <= -150: <= All green LEDs off
+* The blue TX LED indicates when serial data is received over the radio and sent to the host, either over USB or hardware serial.
+* The yellow RX LED indicates when serial data is received from the host and sent over the radio.
 
-## LED Mode 14 (LEDS_GREEN_4_ON)
+## LED Mode - LEDS_MULTIPOINT (0)
 
-This is a testing pattern with only the G4 LED on.
+This mode gives the user insight into when the link is hopping and when a heartbeat is transmitted/received.
 
-## LED Mode 15 (LEDS_ALL_OFF)
+* The G4 LED pulses when the radio transmits a frame.
+* The G3 LED is pulse width modulated to indicate the last received RSSI level.
+* The G2 LED turns on when the link is up (data can pass).
+* The G1 LED pulses when the radio successfully receives a frame.
+* 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.
+* The yellow LED pulses each time a channel hop (frequency change) occurs.
 
-This is a testing pattern with all LEDs on.
+## LED Mode - LEDS_RADIO_USE (3)
 
-## Other LED modes
+This mode gives the user insight into when a bad or duplicate frame is detected.
 
-Undefined LED modes display the RSSI pattern (mode 4).
+* The G4 LED pulses when the radio transmits a frame.
+* The G3 LED is pulse width modulated to indicate the last received RSSI level.
+* The G2 LED turns on when the link is up (data can pass).
+* The G1 LED pulses when the radio successfully receives a frame.
+* The blue LED will blink when the radio receives a bad frame.
+* The yellow LED will blink when the radio receives a duplicate frame or receives a frame where the software CRC does not match.
diff --git a/docs/training.md b/docs/training.md
@@ -2,16 +2,20 @@
 
 Training is the process of passing a radio's set of parameters to other radios so that they can successfully communicate.
 
-There are two ways to initiate training:
-
 ![Training button on LoRaSerial](Original/SparkFun_LoRaSerial_-_Train.png)
 
+*The train button on the LoRaSerial*
+
+There are two ways to initiate training:
+
 * Pressing the **Train** button on the end of the LoRaSerial device
 * Entering the **ATT** command
 
 Training is performed by a server radio sending parameters to the client radio. Upon reception, the client radio saves the parameters in non-volatile memory and then reboots with the new parameters.
 
-Pressing and releasing the training button for different lengths of time initiates the following behaviors:
+Pressing and releasing the training button for different lengths of time initiates the following behaviors.
+
+A ball-point pen is best for pressing the training button. *Be gentle.* The training button can be damaged with too much force.
 
 ## Training as Client
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,6 +3,8 @@ site_name: SparkFun LoRaSerial Product Manual
 site_description: A guide to the SparkFun LoRaSerial hardware, firmware, and features
 site_url: https://sparkfun.github.io/SparkFun_LoRaSerial
 
+repo_name: sparkfun/SparkFun_LoRaSerial
+repo_url: https://github.com/sparkfun/SparkFun_LoRaSerial
 edit_uri: edit/main/docs/
 
 theme:
@@ -16,9 +18,9 @@ theme:
     code: Roboto Mono
   features:
     - content.code.annotate
-    - navigation.tracking
-    - navigation.tabs.sticky
-    - navigation.tabs    
+    # - navigation.tracking
+    # - navigation.tabs.sticky
+    # - navigation.tabs    
 
   icon:
     repo: fontawesome/brands/github
@@ -40,9 +42,6 @@ plugins:
   - search
   - monorepo
 
-repo_url: https://github.com/sparkfun/SparkFun_LoRaSerial
-repo_name: sparkfun/SparkFun_LoRaSerial
-
 copyright: Copyright 2023 SparkFun Electronics (6333 Dry Creek Parkway, Niwot, Colorado 80503)
 
 markdown_extensions:
@@ -74,8 +73,7 @@ extra:
       link: https://twitter.com/sparkfun
   
 nav:
-  - Software Specifics:
-    - intro.md
+    - Introduction: intro.md
     - quick_start.md
     - at_commands.md
     - led_states.md
@@ -84,3 +82,6 @@ nav:
     - firmware_update.md
     - hardware_overview.md
 
+extra:
+  version:
+    provider: mike
