MultilevelSwitch#

Modules#

cc_multilevel_switch_t

Enumerations#

enum

CCMLS_PRIMARY_SWITCH_T {

CCMLS_PRIMARY_SWITCH_UP

CCMLS_PRIMARY_SWITCH_DOWN

CCMLS_PRIMARY_SWITCH_RESERVED

CCMLS_PRIMARY_SWITCH_NO_UP_DOWN_MOTION

}

Enumeration for "Start Level Change" command.

enum

CCMLS_IGNORE_START_LEVEL_T {

CCMLS_IGNORE_START_LEVEL_FALSE

CCMLS_IGNORE_START_LEVEL_TRUE

}

Enumeration for "Start Level Change" command.

enum

CCMLS_SECONDARY_SWITCH_T {

CCMLS_SECONDARY_SWITCH_INCREMENT

CCMLS_SECONDARY_SWITCH_DECREMENT

CCMLS_SECONDARY_SWITCH_RESERVED

CCMLS_SECONDARY_SWITCH_NO_INC_DEC

}

Enumeration for "Start Level Change" command.

Typedefs#

typedef struct cc_multilevel_switch_t

cc_multilevel_switch_t

typedef void(*

cc_multilevel_switch_callback_t)(struct cc_multilevel_switch_t *p_switch)

Functions#

JOB_STATUS

CmdClassMultilevelSwitchStartLevelChange(AGI_PROFILE *pProfile, uint8_t sourceEndpoint, void(*pCbFunc)(TRANSMISSION_RESULT *pTransmissionResult), CCMLS_PRIMARY_SWITCH_T primarySwitch, CCMLS_IGNORE_START_LEVEL_T fIgnoreStartLevel, CCMLS_SECONDARY_SWITCH_T secondarySwitch, uint8_t primarySwitchStartLevel, uint8_t duration, uint8_t secondarySwitchStepSize)

Initiates the transmission of a "Multilevel Switch Start Level Change" command.

JOB_STATUS

CmdClassMultilevelSwitchStopLevelChange(AGI_PROFILE *pProfile, uint8_t sourceEndpoint, void(*pCbFunc)(TRANSMISSION_RESULT *pTransmissionResult))

Initiates the transmission of a "Multilevel Switch Stop Level Change" command.

JOB_STATUS

CmdClassMultilevelSwitchSetTransmit(AGI_PROFILE *pProfile, uint8_t sourceEndpoint, void(*pCbFunc)(TRANSMISSION_RESULT *pTransmissionResult), uint8_t value, uint8_t duration)

Initiates the transmission of a "Multilevel Switch Set" command.

void

cc_multilevel_switch_set(cc_multilevel_switch_t *p_switch, uint8_t value, uint8_t duration)

Sets the value of a given multilevel switch.

void

cc_multilevel_switch_start_level_change(cc_multilevel_switch_t *p_switch, bool up, bool ignore_start_level, uint8_t start_level, uint8_t duration)

Starts changing the value of a given multilevel switch.

void

cc_multilevel_switch_stop_level_change(cc_multilevel_switch_t *p_switch)

Stops an ongoing change of a given multilevel switch.

uint8_t

cc_multilevel_switch_get_current_value(cc_multilevel_switch_t *p_switch)

Returns the current value of a given multilevel switch.

uint8_t

cc_multilevel_switch_get_last_on_value(cc_multilevel_switch_t *p_switch)

Returns the last on-value of a given multilevel switch.

uint8_t

cc_multilevel_switch_get_min_value(void)

Returns the min value of all multilevel switches.

uint8_t

cc_multilevel_switch_get_max_value(void)

Returns the max value of all multilevel switches.

void

cc_multilevel_switch_support_cb(struct cc_multilevel_switch_t *p_switch)

cc_multilevel_switch_t *

cc_multilevel_switch_support_config_get_switches(void)

uint8_t

cc_multilevel_switch_support_config_get_length_switches(void)

uint8_t

cc_multilevel_switch_support_config_get_default_duration(void)

bool

cc_multilevel_switch_write(uint8_t multilevel_component_id, cc_multilevel_switch_t *multilevel_switch)

bool

cc_multilevel_switch_read(uint8_t multilevel_component_id, cc_multilevel_switch_t *multilevel_switch)

Enumeration Documentation#

CCMLS_PRIMARY_SWITCH_T#

CCMLS_PRIMARY_SWITCH_T

Enumeration for "Start Level Change" command.

Enumerator
CCMLS_PRIMARY_SWITCH_UP	CCMLS_PRIMARY_SWITCH_UP.
CCMLS_PRIMARY_SWITCH_DOWN	CCMLS_PRIMARY_SWITCH_DOWN.
CCMLS_PRIMARY_SWITCH_RESERVED	CCMLS_PRIMARY_SWITCH_RESERVED.
CCMLS_PRIMARY_SWITCH_NO_UP_DOWN_MOTION	CCMLS_PRIMARY_SWITCH_NO_UP_DOWN_MOTION.

Definition at line 32 of file

/mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/MultilevelSwitch/inc/CC_MultilevelSwitch_Control.h

CCMLS_IGNORE_START_LEVEL_T#

CCMLS_IGNORE_START_LEVEL_T

Enumeration for "Start Level Change" command.

Enumerator
CCMLS_IGNORE_START_LEVEL_FALSE	CCMLS_IGNORE_START_LEVEL_FALSE.
CCMLS_IGNORE_START_LEVEL_TRUE	CCMLS_IGNORE_START_LEVEL_TRUE.

Definition at line 44 of file

/mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/MultilevelSwitch/inc/CC_MultilevelSwitch_Control.h

CCMLS_SECONDARY_SWITCH_T#

CCMLS_SECONDARY_SWITCH_T

Enumeration for "Start Level Change" command.

Enumerator
CCMLS_SECONDARY_SWITCH_INCREMENT	CCMLS_SECONDARY_SWITCH_INCREMENT.
CCMLS_SECONDARY_SWITCH_DECREMENT	CCMLS_SECONDARY_SWITCH_DECREMENT.
CCMLS_SECONDARY_SWITCH_RESERVED	CCMLS_SECONDARY_SWITCH_RESERVED.
CCMLS_SECONDARY_SWITCH_NO_INC_DEC	CCMLS_SECONDARY_SWITCH_NO_INC_DEC.

Definition at line 54 of file

/mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/MultilevelSwitch/inc/CC_MultilevelSwitch_Control.h

Typedef Documentation#

cc_multilevel_switch_t#

typedef struct cc_multilevel_switch_t cc_multilevel_switch_t

Definition at line 38 of file

/mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/MultilevelSwitch/inc/CC_MultilevelSwitch_Support.h

cc_multilevel_switch_callback_t#

typedef void(* cc_multilevel_switch_callback_t) (struct cc_multilevel_switch_t *p_switch) )(struct cc_multilevel_switch_t *p_switch)

Definition at line 40 of file

/mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/MultilevelSwitch/inc/CC_MultilevelSwitch_Support.h

Function Documentation#

CmdClassMultilevelSwitchStartLevelChange#

JOB_STATUS CmdClassMultilevelSwitchStartLevelChange (AGI_PROFILE * pProfile, uint8_t sourceEndpoint, void(*)(TRANSMISSION_RESULT *pTransmissionResult) pCbFunc, CCMLS_PRIMARY_SWITCH_T primarySwitch, CCMLS_IGNORE_START_LEVEL_T fIgnoreStartLevel, CCMLS_SECONDARY_SWITCH_T secondarySwitch, uint8_t primarySwitchStartLevel, uint8_t duration, uint8_t secondarySwitchStepSize)

Initiates the transmission of a "Multilevel Switch Start Level Change" command.

Parameters

[in]	pProfile	pointer to AGI profile or NULL for lifeline
[in]	sourceEndpoint	source endpoint
[out]	pCbFunc	Callback function to be called when transmission is done/failed.
[in]	primarySwitch	Controls the primary device functionality.
[in]