ColorSwitch#

Modules#

colorComponent_

Enumerations#

enum

EColorComponents_ {

ECOLORCOMPONENT_WARM_WHITE

ECOLORCOMPONENT_COLD_WHITE

ECOLORCOMPONENT_RED

ECOLORCOMPONENT_GREEN

ECOLORCOMPONENT_BLUE

ECOLORCOMPONENT_AMBER

ECOLORCOMPONENT_CYAN

ECOLORCOMPONENT_PURPLE

ECOLORCOMPONENT_COLOR_UNDEFINED

}

Defined Color Components ID.

Typedefs#

typedef enum EColorComponents_

EColorComponents

Defined Color Components ID.

typedef struct colorComponent_

s_colorComponent

Structure that holds Color Switch CC related data.

Functions#

void

cc_color_switch_refresh_cb(void)

Can be used as single cb function for all colors.

void

cc_color_switch_cb(s_colorComponent *colorComponent)

s_colorComponent *

cc_color_switch_get_colorComponents(void)

uint8_t

cc_color_switch_get_length_colorComponents(void)

uint8_t

cc_color_switch_get_default_duration(void)

bool

cc_color_switch_write(uint8_t color_component_id, s_colorComponent *color_component)

bool

cc_color_switch_read(uint8_t color_component_id, s_colorComponent *color_component)

Enumeration Documentation#

EColorComponents_#

EColorComponents_

Defined Color Components ID.

Enumerator
ECOLORCOMPONENT_WARM_WHITE	ECOLORCOMPONENT_WARM_WHITE.
ECOLORCOMPONENT_COLD_WHITE	ECOLORCOMPONENT_COLD_WHITE.
ECOLORCOMPONENT_RED	ECOLORCOMPONENT_RED.
ECOLORCOMPONENT_GREEN	ECOLORCOMPONENT_GREEN.
ECOLORCOMPONENT_BLUE	ECOLORCOMPONENT_BLUE.
ECOLORCOMPONENT_AMBER	ECOLORCOMPONENT_AMBER.
ECOLORCOMPONENT_CYAN	ECOLORCOMPONENT_CYAN (For 6ch color mixing)
ECOLORCOMPONENT_PURPLE	ECOLORCOMPONENT_PURPLE (For 6ch color mixing)
ECOLORCOMPONENT_COLOR_UNDEFINED

Definition at line 23 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/inc/CC_ColorSwitch.h

Typedef Documentation#

EColorComponents#

typedef enum EColorComponents_ EColorComponents

Defined Color Components ID.

Definition at line 34 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/inc/CC_ColorSwitch.h

s_colorComponent#

typedef struct colorComponent_ s_colorComponent

Structure that holds Color Switch CC related data.

Definition at line 48 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/inc/CC_ColorSwitch.h

Function Documentation#

cc_color_switch_refresh_cb#

void cc_color_switch_refresh_cb (void )

Can be used as single cb function for all colors.

Parameters

N/A

Defined in the app. Called when change takes place in driver and app needs to update LED status

Definition at line 55 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/inc/CC_ColorSwitch.h

cc_color_switch_cb#

void cc_color_switch_cb (s_colorComponent * colorComponent)

Parameters

N/A colorComponent

Definition at line 19 of file

/mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/src/cc_color_switch_config_api.h

cc_color_switch_get_colorComponents#

s_colorComponent * cc_color_switch_get_colorComponents (void )

Parameters

N/A

Definition at line 20 of file

/mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/src/cc_color_switch_config_api.h

cc_color_switch_get_length_colorComponents#

uint8_t cc_color_switch_get_length_colorComponents (void )

Parameters

N/A

Definition at line 21 of file

/mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/src/cc_color_switch_config_api.h

cc_color_switch_get_default_duration#

uint8_t cc_color_switch_get_default_duration (void )

Parameters

N/A

Definition at line 22 of file

/mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/src/cc_color_switch_config_api.h

cc_color_switch_write#

bool cc_color_switch_write (uint8_t color_component_id, s_colorComponent * color_component)

Parameters

N/A	color_component_id
N/A	color_component

Definition at line 19 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/src/cc_color_switch_io.h

cc_color_switch_read#

bool cc_color_switch_read (uint8_t color_component_id, s_colorComponent * color_component)

Parameters

N/A	color_component_id
N/A	color_component

Definition at line 20 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/ColorSwitch/src/cc_color_switch_io.h