Files
beagleconnect-freedom/docs/LED.md
Jason Kridner 947ad003b2 Update LED.md
2022-08-04 13:28:04 -04:00

4.5 KiB

LED definition

These definitions are proposed with the mindset of giving end-users high-level functional status indication of the devices and nodes. It seeks to avoid having the status of any one LED being required to interpret another, which has the undesirable effect of limiting the amount of information that can be conveyed, but should simplify interpretation.

Single letter abbreviations are provided in case we can put these on a silkscreen on the side of the case.

Positions

#TODO: - I need to determine for sure where each LED is on the board and make it clear in this document.

Functions

LED Signal Status Indication
CHG (Charging) D7, CHG (no S/W control) On Charger active
Off Charger not active
LNK (Link) D6, 2.4G (DIO_18 on CC1352) On Radio RX within timeout
Fast blink Radio active
Off Radio RX inactive (timeout)
Slow blink Radio error
USB (USB) D5, 900M (P6.1 on MSP430) On Device in gateway mode
Fast blink USB active
Off Device in node mode
Slow blink Seeking USB (gateway) connection
PWR (Power) D4, PWR (no S/W control) On Device powered
Off Device not powered
MB1 (mikroBUS 1) D3, LED1 (P6.2 on MSP430) On Identified and connected
Fast blink (w/o 2) Active
Fast blink (w/ 2) Internal sensor active
Off Inactive
Slow blink (w/o 2) Identified, but not connected
Slow blink (w/ 2) Seeking Greybus connection
MB2 (mikroBUS 2) D2, LED2 (P6.3 on MSP430) On Identified and connected
Fast blink (w/o 1) Active
Fast blink (w/ 1) Internal sensor active
Off Inactive
Slow blink (w/o 1) Identified, but not connected
Slow blink (w/ 1) Seeking Greybus connection

Modes

Mode/firmware Submode USB LED (U) MikroBUS LEDs (1/2)
Sensortest node - off off
Greybus node searching off slow blink
searching connected off
Mode/firmware USB LED MikroBUS 1/2 LEDs
Sensortest node off off
Greybus node off slow blink, fast blink, or on (not off)
Gateway slow blink, fast blink, or on (not off) off

Implementation

CC1352

  • We've got a hook for TX toggle at the antenna switch. A global variable can remember if we should leave it on or off.
  • I need to look for where we have RX at the level of valid IEEE802.15.4 packets on the SubG radio. I think we can set the flag there, but probably need a mutex.

USB

MSP430

  • A global flag to reflect the LED mode
  • Set the LED if USB connected and HDLC connection established with gateway firmware
  • Toggle the LED status with short pulses based on getting or sending USB traffic
  • Toggle the LED slow if USB is connected, but not in HDLC mode (passthrough or searching for HDLC)

1/2

TBD