Myriota Flex SDK 2.5.0
Loading...
Searching...
No Matches
LED Control

Control the LED on the FlexSense board. More...

Enumerations

enum  FLEX_LEDState { FLEX_LED_ON , FLEX_LED_OFF }
 LED States. More...
 

Functions

int FLEX_LEDGreenStateSet (const FLEX_LEDState LEDState)
 
int FLEX_LEDBlueStateSet (const FLEX_LEDState LEDState)
 

Detailed Description

Control the LED on the FlexSense board.

The FlexSense offers a Blue and Green LED that can be individually controlled.

Warning
To maximise the battery life of your FlexSense, we recommend limiting how often and how long the LED is on.

Enumeration Type Documentation

◆ FLEX_LEDState

LED States.

Enumerator
FLEX_LED_ON 

turn LED On

FLEX_LED_OFF 

turn LED Off

Function Documentation

◆ FLEX_LEDGreenStateSet()

int FLEX_LEDGreenStateSet ( const FLEX_LEDState LEDState)

Change the state of the Green LED.

Note
To maximise the battery life of your FlexSense, we recommend limiting how often and how long the LED is on.
Parameters
[in]LEDStatethe required LED state selected from FLEX_LEDState.
Returns
FLEX_SUCCESS (0) if succeeded and < 0 if failed.
Return values
-FLEX_ERROR_IO_EXPANDERfailed to initialise or configure expander device

◆ FLEX_LEDBlueStateSet()

int FLEX_LEDBlueStateSet ( const FLEX_LEDState LEDState)

Change the state of the Blue LED.

Note
To maximise the battery life of your FlexSense, we recommend limiting how often and how long the LED is on.
Parameters
[in]LEDStatethe required LED state selected from FLEX_LEDState.
Returns
FLEX_SUCCESS (0) if succeeded and < 0 if failed.
Return values
-FLEX_ERROR_IO_EXPANDERfailed to initialise or configure expander device