Binary Switch#
Modules#
Typedefs#
typedef void(*
cc_binary_switch_callback_t)(struct cc_binary_switch_t *p_switch)
typedef struct cc_binary_switch_t
Functions#
cc_binary_switch_set_handler(uint8_t value, uint8_t duration, uint8_t endpoint)
Handler for mapping Basic Set to Multilevel Switch Set.
void
cc_binary_switch_set(cc_binary_switch_t *p_switch, uint8_t value)
Sets the value of a given binary switch.
uint8_t
cc_binary_switch_get_current_value(cc_binary_switch_t *p_switch)
Returns the current value of a given binary switch.
void
cc_binary_switch_handler(cc_binary_switch_t *p_switch)
uint8_t
Macros#
#define
#define
#define
#define
#define
#define
BIN_SWITCH_DURATION_MAX_MINUTES (BIN_SWITCH_DURATION_MAX_VAL_MINUTES - BIN_SWITCH_DURATION_MIN_VAL_MINUTES)
Typedef Documentation#
cc_binary_switch_callback_t#
typedef void(* cc_binary_switch_callback_t) (struct cc_binary_switch_t *p_switch) )(struct cc_binary_switch_t *p_switch)
Definition at line
30 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hcc_binary_switch_t#
typedef struct cc_binary_switch_t cc_binary_switch_t
Definition at line
49 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hFunction Documentation#
cc_binary_switch_set_handler#
e_cmd_handler_return_code_t cc_binary_switch_set_handler (uint8_t value, uint8_t duration, uint8_t endpoint)
Handler for mapping Basic Set to Multilevel Switch Set.
Parameters
| [in] | value | Mapped value. |
| [in] | duration | Mapped duration. |
| [in] | endpoint | Mapped endpoint. |
This function MUST NOT be used for anything else than mapping. Returns
Result of the set command. E_CMD_HANDLER_RETURN_CODE_HANDLED if the actual value was set to the given value right away. E_CMD_HANDLER_RETURN_CODE_WORKING if the actual value is transitioning to the given value. E_CMD_HANDLER_RETURN_CODE_FAIL if the parameters were incorrect.
Definition at line
63 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hcc_binary_switch_set#
void cc_binary_switch_set (cc_binary_switch_t * p_switch, uint8_t value)
Sets the value of a given binary switch.
Parameters
| N/A | p_switch | The switch of which the value is set. |
| N/A | value | The value to set. |
This function can be used in an application that might have a button.
Must be used for local actuation only.
Definition at line
76 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hcc_binary_switch_get_current_value#
uint8_t cc_binary_switch_get_current_value (cc_binary_switch_t * p_switch)
Returns the current value of a given binary switch.
Parameters
| N/A | p_switch | The switch of which the value is returned. |
Must be used for local actuation only. Returns
Current value of the given switch.
Definition at line
85 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hcc_binary_switch_handler#
void cc_binary_switch_handler (cc_binary_switch_t * p_switch)
Parameters
| N/A | p_switch |
Definition at line
92 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hcc_binary_switch_get_config#
cc_binary_switch_t * cc_binary_switch_get_config (void )
Parameters
| N/A |
Returns
cc_binary_switch_t*
Definition at line
99 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hcc_binary_switch_get_config_length#
uint8_t cc_binary_switch_get_config_length (void )
Parameters
| N/A |
Returns
uint8_t
Definition at line
106 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hMacro Definition Documentation#
BIN_SWITCH_DURATION_MIN_VAL_SECONDS#
#define BIN_SWITCH_DURATION_MIN_VAL_SECONDSValue:
0x00
Definition at line
21 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hBIN_SWITCH_DURATION_MAX_VAL_SECONDS#
#define BIN_SWITCH_DURATION_MAX_VAL_SECONDSValue:
0x7F
Definition at line
22 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hBIN_SWITCH_DURATION_MIN_VAL_MINUTES#
#define BIN_SWITCH_DURATION_MIN_VAL_MINUTESValue:
0x80
Definition at line
23 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hBIN_SWITCH_DURATION_MAX_VAL_MINUTES#
#define BIN_SWITCH_DURATION_MAX_VAL_MINUTESValue:
0xFE
Definition at line
24 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hBIN_SWITCH_DURATION_FACTORY_DEFAULT#
#define BIN_SWITCH_DURATION_FACTORY_DEFAULTValue:
0xFF
Definition at line
25 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.hBIN_SWITCH_DURATION_MAX_MINUTES#
#define BIN_SWITCH_DURATION_MAX_MINUTESValue:
(BIN_SWITCH_DURATION_MAX_VAL_MINUTES - BIN_SWITCH_DURATION_MIN_VAL_MINUTES)
Definition at line
26 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h