LED Control
Hardware Abstraction Layer (HAL) API Reference > Sample APIs for Peripheral Access

Sample API funtions for controlling LEDs. More...

Typedefs

typedef enum HalBoardLedPins HalBoardLed
Ensures that the definitions from the BOARD_HEADER are always used as parameters to the LED functions. More...

Functions

void halInternalInitLed (void)
Configures GPIOs pertaining to the control of LEDs. More...
void halToggleLed ( HalBoardLed led)
Atomically wraps an XOR or similar operation for a single GPIO pin attached to an LED. More...
void halSetLed ( HalBoardLed led)
Turns on (sets) a GPIO pin connected to an LED so that the LED turns on. More...
void halClearLed ( HalBoardLed led)
Turns off (clears) a GPIO pin connected to an LED, which turns off the LED. More...
void halStackIndicateActivity (bool turnOn)
Called by the stack to indicate activity over the radio (for both transmission and reception). It is called once with turnOn true and shortly thereafter with turnOn false. More...

Detailed Description

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.

Typedef Documentation

◆ HalBoardLed

typedef enum HalBoardLedPins HalBoardLed

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

Definition at line 78 of file led.h .

Function Documentation

◆ halClearLed()

void halClearLed ( HalBoardLed led )

Turns off (clears) a GPIO pin connected to an LED, which turns off the LED.

Parameters
led Identifier (from BOARD_HEADER) for the LED to turn off.

◆ halInternalInitLed()

void halInternalInitLed ( void )

Configures GPIOs pertaining to the control of LEDs.

◆ halSetLed()

void halSetLed ( HalBoardLed led )

Turns on (sets) a GPIO pin connected to an LED so that the LED turns on.

Parameters
led Identifier (from BOARD_HEADER) for the LED to turn on.

◆ halStackIndicateActivity()

void halStackIndicateActivity ( bool turnOn )

Called by the stack to indicate activity over the radio (for both transmission and reception). 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.

Parameters
turnOn See Usage.

◆ halToggleLed()

void halToggleLed ( HalBoardLed led )

Atomically wraps an XOR or similar operation for a single GPIO pin attached to an LED.

Parameters
led Identifier (from BOARD_HEADER) for the LED to be toggled.