LED#

Sample API funtions for controlling LEDs.

When specifying an LED to use, always use the BOARDLEDx definitions that are defined within the BOARD_HEADER.

See led.h for source code.

Typedefs#

typedef enum HalBoardLedPins

Ensures that the definitions from the BOARD_HEADER are always used as parameters to the LED functions.

Functions#

void

Configures GPIOs pertaining to the control of LEDs.

void

Called by the stack to indicate activity over the radio (for both transmission and reception).

Typedef Documentation#

HalBoardLed#

typedef enum HalBoardLedPins HalBoardLed

Ensures that the definitions from the BOARD_HEADER are always used as parameters to the LED functions.


Function Documentation#

halInternalInitLed#

void halInternalInitLed (void )

Configures GPIOs pertaining to the control of LEDs.

Parameters
TypeDirectionArgument NameDescription
voidN/A

halStackIndicateActivity#

void halStackIndicateActivity (bool turnOn)

Called by the stack to indicate activity over the radio (for both transmission and reception).

Parameters
TypeDirectionArgument NameDescription
boolN/AturnOn

See Usage.

It is called once with turnOn true and shortly thereafter with turnOn false.

Typically does something interesting, such as change the state of an LED.