System indicator types. More...

Data Structures

struct gos_system_indicator_callback_info_t
Additional callback information. More...

Typedefs

typedef void(* gos_system_indicator_callback_t ) (bool value, const gos_system_indicator_callback_info_t *info)
System indicator callback. More...

Enumerations

enum gos_system_indicator_operation_t {
GOS_SYSTEM_INDICATOR_STATIC_OFF ,
GOS_SYSTEM_INDICATOR_STATIC_ON ,
GOS_SYSTEM_INDICATOR_SLOW_BLINK ,
GOS_SYSTEM_INDICATOR_MEDIUM_BLINK ,
GOS_SYSTEM_INDICATOR_FAST_BLINK ,
GOS_SYSTEM_INDICATOR_OPERATION_COUNT ,
GOS_SYSTEM_INDICATOR_OPERATION_INVALID = GOS_SYSTEM_INDICATOR_OPERATION_COUNT
}
Indicator operation. More...
enum gos_system_indicator_state_t {
GOS_SYSTEM_INDICATOR_STATE_0 ,
GOS_SYSTEM_INDICATOR_STATE_1 ,
GOS_SYSTEM_INDICATOR_STATE_2 ,
GOS_SYSTEM_INDICATOR_STATE_3 ,
GOS_SYSTEM_INDICATOR_STATE_COUNT ,
GOS_SYSTEM_INDICATOR_STATE_INVALID = GOS_SYSTEM_INDICATOR_STATE_COUNT
}
Indicator state. More...
enum gos_system_indicator_t {
GOS_SYSTEM_INDICATOR_NETWORK ,
GOS_SYSTEM_INDICATOR_SOFTAP ,
GOS_SYSTEM_INDICATOR_WLAN ,
GOS_SYSTEM_INDICATOR_COUNT
}
System event indicators. More...

Detailed Description

System indicator types.

Typedef Documentation

gos_system_indicator_callback_t

typedef void(* gos_system_indicator_callback_t) (bool value, const gos_system_indicator_callback_info_t *info)

System indicator callback.

This callback is invoked when a system indicator's, gos_system_indicator_t , state changes.

This callback can be used to blink LEDs that are not directly connected to a GPIO.

The value argument indicates if the indicator should be 'on' or 'off'

Note
This callback executes in the system event thread context
Parameters
indicator System indicator whose state has changed, see gos_system_indicator_t
value The current value of the indicator
info Additional information about the indicator's current state, see gos_system_indicator_callback_info_t

Enumeration Type Documentation

gos_system_indicator_operation_t

Indicator operation.

Enumerator
GOS_SYSTEM_INDICATOR_STATIC_OFF

Indicator is always off.

GOS_SYSTEM_INDICATOR_STATIC_ON

Indicator is always on.

GOS_SYSTEM_INDICATOR_SLOW_BLINK

Indicator blinks at slow rate.

GOS_SYSTEM_INDICATOR_MEDIUM_BLINK

Indicator blinks at medium rate.

GOS_SYSTEM_INDICATOR_FAST_BLINK

Indicator blinks at fast rate.

GOS_SYSTEM_INDICATOR_OPERATION_COUNT

Indicator operation count.

GOS_SYSTEM_INDICATOR_OPERATION_INVALID

Invalid operation.

gos_system_indicator_state_t

Indicator state.

Enumerator
GOS_SYSTEM_INDICATOR_STATE_0

State 0.

GOS_SYSTEM_INDICATOR_STATE_1

State 1.

GOS_SYSTEM_INDICATOR_STATE_2

State 2.

GOS_SYSTEM_INDICATOR_STATE_3

State 3.

GOS_SYSTEM_INDICATOR_STATE_COUNT

State count.

GOS_SYSTEM_INDICATOR_STATE_INVALID

Invalid state.

gos_system_indicator_t

System event indicators.

Enumerator
GOS_SYSTEM_INDICATOR_NETWORK

Network event indicator.

GOS_SYSTEM_INDICATOR_SOFTAP

SoftAP event indicator.

GOS_SYSTEM_INDICATOR_WLAN

WLAN event indicator.

GOS_SYSTEM_INDICATOR_COUNT

Indicator count.