Indicator#

Indicator CC is mandatory since Z-Wave+ V2.

It can be used to identify a device in the network, by sending command that will, for example, set the LED indicator to ON over a certain period.

Modules#

s_CC_indicator_data_t_

Typedefs#

typedef struct s_CC_indicator_data_t_
s_CC_indicator_data_t

Struct used to pass operational data to TSE module.

Functions#

void
CC_Indicator_RefreshIndicatorProperties(void)

Resets the indicator CC properties to their "off" values.

void
cc_indicator_handler(uint32_t on_time_ms, uint32_t off_time_ms, uint32_t num_cycles)

CC Indicator handler that MUST be defined by the platform specific application source code to signal patterns.

Macros#

#define
INDICATOR_IND_NA INDICATOR_SET_NA_V3
#define
INDICATOR_IND_NODE_IDENTIFY INDICATOR_SET_NODE_IDENTIFY_V3
#define
INDICATOR_PROP_ON_OFF_PERIOD INDICATOR_SET_ON_OFF_PERIOD_V3
#define
INDICATOR_PROP_ON_OFF_CYCLES INDICATOR_SET_ON_OFF_CYCLES_V3
#define
INDICATOR_PROP_ON_TIME INDICATOR_SET_ONE_TIME_ON_OFF_PERIOD_V3
#define
INDICATOR_OBJECT_COUNT_MASK INDICATOR_SET_PROPERTIES1_INDICATOR_OBJECT_COUNT_MASK_V3
#define
INDICATOR_RESERVED_MASK INDICATOR_SET_PROPERTIES1_RESERVED_MASK_V3
#define
INDICATOR_RESERVED_SHIFT INDICATOR_SET_PROPERTIES1_RESERVED_SHIFT_V3

Typedef Documentation#

s_CC_indicator_data_t#

typedef struct s_CC_indicator_data_t_ s_CC_indicator_data_t

Struct used to pass operational data to TSE module.

See ZAF_TSE_Trigger() for more information.

  • Receive options MUST be the first element as TSE relies on the receive options.


Definition at line 44 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/inc/CC_Indicator.h

Function Documentation#

CC_Indicator_RefreshIndicatorProperties#

void CC_Indicator_RefreshIndicatorProperties (void )

Resets the indicator CC properties to their "off" values.

Parameters
N/A

If the application manually de-activates the Indicator (e.g. learn mode), it should call this function to have the CC Indicator values refreshed before it reports its state to the Lifeline destinations.

When starting a blink sequence we simply off load the blinking to a board specific indicator LED implementation. The indicator command class does not keep time on when the indicator LED has completed its blink sequence, instead it queries the board when a GET request is received.


Definition at line 59 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/inc/CC_Indicator.h

cc_indicator_handler#

void cc_indicator_handler (uint32_t on_time_ms, uint32_t off_time_ms, uint32_t num_cycles)

CC Indicator handler that MUST be defined by the platform specific application source code to signal patterns.

Parameters
N/Aon_time_ms

ON duration (in milliseconds) for a single blink cycle. If on_time_ms is zero the indicator should be turned off.

N/Aoff_time_ms

OFF duration (in milliseconds) for a single blink cycle.

N/Anum_cycles

Number of blink cycles. If num_cycles is zero the indicator LED should blink "forever" or until the next time this function is called.

Even though on/off time parameters are given in milliseconds, the resolution is 1/10'th of a second.


Definition at line 77 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/inc/CC_Indicator.h

Macro Definition Documentation#

INDICATOR_IND_NA#

#define INDICATOR_IND_NA
Value:
INDICATOR_SET_NA_V3

Definition at line 24 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_IND_NODE_IDENTIFY#

#define INDICATOR_IND_NODE_IDENTIFY
Value:
INDICATOR_SET_NODE_IDENTIFY_V3

Definition at line 25 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_PROP_ON_OFF_PERIOD#

#define INDICATOR_PROP_ON_OFF_PERIOD
Value:
INDICATOR_SET_ON_OFF_PERIOD_V3

Definition at line 28 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_PROP_ON_OFF_CYCLES#

#define INDICATOR_PROP_ON_OFF_CYCLES
Value:
INDICATOR_SET_ON_OFF_CYCLES_V3

Definition at line 29 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_PROP_ON_TIME#

#define INDICATOR_PROP_ON_TIME
Value:
INDICATOR_SET_ONE_TIME_ON_OFF_PERIOD_V3

Definition at line 30 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_OBJECT_COUNT_MASK#

#define INDICATOR_OBJECT_COUNT_MASK
Value:
INDICATOR_SET_PROPERTIES1_INDICATOR_OBJECT_COUNT_MASK_V3

Definition at line 33 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_RESERVED_MASK#

#define INDICATOR_RESERVED_MASK
Value:
INDICATOR_SET_PROPERTIES1_RESERVED_MASK_V3

Definition at line 34 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h

INDICATOR_RESERVED_SHIFT#

#define INDICATOR_RESERVED_SHIFT
Value:
INDICATOR_SET_PROPERTIES1_RESERVED_SHIFT_V3

Definition at line 35 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Indicator/src/CC_IndicatorPrivate.h