Binary Switch#

Modules#

cc_binary_switch_t

Enumerations#

enum
cc_binary_switch_event_t {
CC_BINARY_SWITCH_EVENT_START_LEVEL_CHANGE
CC_BINARY_SWITCH_EVENT_REACHED_FINAL_VALUE
}

Typedefs#

typedef void(*
cc_binary_switch_callback_t)(struct cc_binary_switch_t *p_switch)

Functions#

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.

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)

Macros#

#define
BIN_SWITCH_DURATION_MAX_MINUTES (BIN_SWITCH_DURATION_MAX_VAL_MINUTES - BIN_SWITCH_DURATION_MIN_VAL_MINUTES)

Enumeration Documentation#

cc_binary_switch_event_t#

cc_binary_switch_event_t
Enumerator
CC_BINARY_SWITCH_EVENT_START_LEVEL_CHANGE

The switch pointed to by the event data has started changing level.

CC_BINARY_SWITCH_EVENT_REACHED_FINAL_VALUE

The switch pointed to by the event data has reached its final value.


Definition at line 51 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

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.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_binary_switch_t#

typedef struct cc_binary_switch_t cc_binary_switch_t

Definition at line 49 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_binary_switch_event_t#

typedef enum cc_binary_switch_event_t cc_binary_switch_event_t

Definition at line 54 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

Function 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


Definition at line 68 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_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/Ap_switch

The switch of which the value is set.

N/Avalue

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 81 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_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/Ap_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 90 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_binary_switch_handler#

void cc_binary_switch_handler (cc_binary_switch_t * p_switch)
Parameters
N/Ap_switch

Definition at line 97 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_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 104 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

cc_binary_switch_get_config_length#

uint8_t cc_binary_switch_get_config_length (void )
Parameters
N/A

Returns

  • uint8_t


Definition at line 111 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

Macro Definition Documentation#

BIN_SWITCH_DURATION_MIN_VAL_SECONDS#

#define BIN_SWITCH_DURATION_MIN_VAL_SECONDS
Value:
0x00

Definition at line 21 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

BIN_SWITCH_DURATION_MAX_VAL_SECONDS#

#define BIN_SWITCH_DURATION_MAX_VAL_SECONDS
Value:
0x7F

Definition at line 22 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

BIN_SWITCH_DURATION_MIN_VAL_MINUTES#

#define BIN_SWITCH_DURATION_MIN_VAL_MINUTES
Value:
0x80

Definition at line 23 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

BIN_SWITCH_DURATION_MAX_VAL_MINUTES#

#define BIN_SWITCH_DURATION_MAX_VAL_MINUTES
Value:
0xFE

Definition at line 24 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

BIN_SWITCH_DURATION_FACTORY_DEFAULT#

#define BIN_SWITCH_DURATION_FACTORY_DEFAULT
Value:
0xFF

Definition at line 25 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h

BIN_SWITCH_DURATION_MAX_MINUTES#

#define BIN_SWITCH_DURATION_MAX_MINUTES
Value:
(BIN_SWITCH_DURATION_MAX_VAL_MINUTES - BIN_SWITCH_DURATION_MIN_VAL_MINUTES)

Definition at line 26 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/BinarySwitch/inc/CC_BinarySwitch.h