DoorLock#

Modules#

cc_door_lock_capabilities_report_t

cc_door_lock_configuration_t

cc_door_lock_data_t

_door_lock_hw_data_t

DoorLockEvents

Enumerations#

enum
DOOR_MODE_UNSECURE = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_V2
DOOR_MODE_UNSECURE_TIMEOUT = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_WITH_TIMEOUT_V2
DOOR_MODE_UNSECURE_INSIDE = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_INSIDE_DOOR_HANDLES_V2
DOOR_MODE_UNSECURE_INSIDE_TIMEOUT = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_INSIDE_DOOR_HANDLES_WITH_TIMEOUT_V2
DOOR_MODE_UNSECURE_OUTSIDE = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_OUTSIDE_DOOR_HANDLES_V2
DOOR_MODE_UNSECURE_OUTSIDE_TIMEOUT = DOOR_LOCK_OPERATION_SET_DOOR_UNSECURED_FOR_OUTSIDE_DOOR_HANDLES_WITH_TIMEOUT_V2
DOOR_MODE_UNKNOWN = DOOR_LOCK_OPERATION_SET_DOOR_LOCK_STATE_UNKNOWN_V2
DOOR_MODE_SECURED = DOOR_LOCK_OPERATION_SET_DOOR_SECURED_V2
}

Door Lock Mode (8 bit) will set the door lock device in unsecured or secured mode as well as other peripheral settings.

enum
DOOR_OPERATION_CONST = 0x01
DOOR_OPERATION_TIMED = 0x02
DOOR_OPERATION_RESERVED = 0x03
}

Operation mode (1byte).

enum
DOOR_COMPONENT_DOOR = 0x01
DOOR_COMPONENT_BOLT = 0x02
DOOR_COMPONENT_LATCH = 0x04
}

Supported Door Components Bitmask of supported door components.

enum
DOOR_HANDLE_DISABLED = 0x00
DOOR_HANDLE_1 = 0x01
DOOR_HANDLE_2 = 0x02
DOOR_HANDLE_3 = 0x04
DOOR_HANDLE_4 = 0x08
}

Supported Door Handles Bitmask of supported door handles.

Typedefs#

typedef struct _door_lock_hw_data_t

Physical components of Door Lock.

Functions#

void

Latch status handler.

void
void

Bolt status handler.

void
CC_DoorLock_SetOutsideDoorHandleState(cc_door_lock_handle_t handle)

Sets the Outside Door Handle State for a specific handle.

void
CC_DoorLock_ClearOutsideDoorHandleState(cc_door_lock_handle_t handle)

Clears the Outside Door Handle State for a specific handle.

uint8_t
cc_door_lock_mode_hw_change(door_lock_mode_t mode)

Initiates change on the hardware that changes door lock mode.

bool

Returns bolt state.

bool
cc_door_lock_write(cc_door_lock_data_t *door_lock_data)
bool
cc_door_lock_read(cc_door_lock_data_t *door_lock_data)

Macros#

#define

Disabling Lock timeout minutes and seconds.

Enumeration Documentation#

door_lock_mode_t#

door_lock_mode_t

Door Lock Mode (8 bit) will set the door lock device in unsecured or secured mode as well as other peripheral settings.

1) Constant mode. Door will be unsecured until set back to secured mode by Command. 2) Timeout mode. Fallback to secured mode after timeout has expired (set by Door Lock Configuration Set). 3) This is Read Only State, i.e. Bolt is not fully retracted/engaged

Enumerator
DOOR_MODE_UNSECURE

Door Unsecured 1)

DOOR_MODE_UNSECURE_TIMEOUT

Door Unsecured with timeout 2)

DOOR_MODE_UNSECURE_INSIDE

Door Unsecured for inside Door Handles 1)

DOOR_MODE_UNSECURE_INSIDE_TIMEOUT

Door Unsecured for inside Door Handles with timeout 2)

DOOR_MODE_UNSECURE_OUTSIDE

Door Unsecured for outside Door Handles 1)

DOOR_MODE_UNSECURE_OUTSIDE_TIMEOUT

Door Unsecured for outside Door Handles with timeout 2)

DOOR_MODE_UNKNOWN

Door/Lock State Unknown 3).

DOOR_MODE_SECURED

Door Secured.


Definition at line 38 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/DoorLock/inc/CC_DoorLock.h

cc_door_lock_operation_type_t#

cc_door_lock_operation_type_t

Operation mode (1byte).

The Operation Type field can be set to either constant or timed operation. When timed operation is set, the Lock Timer Minutes and Lock Timer Seconds fields MUST be set to valid values.

Enumerator
DOOR_OPERATION_CONST

Constant operation.

DOOR_OPERATION_TIMED

Timed operation.

DOOR_OPERATION_RESERVED

0X03..0XFF Reserved


Definition at line 56 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/DoorLock/inc/CC_DoorLock.h

cc_door_lock_door_component_t#

cc_door_lock_door_component_t

Supported Door Components Bitmask of supported door components.

Set to 1 if corresponding component is supported.

Enumerator
DOOR_COMPONENT_DOOR
DOOR_COMPONENT_BOLT
DOOR_COMPONENT_LATCH

Definition at line 68 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/DoorLock/inc/CC_DoorLock.h

cc_door_lock_handle_t#

cc_door_lock_handle_t

Supported Door Handles Bitmask of supported door handles.

Set to 1 if corresponding handle is supported.

Enumerator
DOOR_HANDLE_DISABLED
DOOR_HANDLE_1
DOOR_HANDLE_2
DOOR_HANDLE_3
DOOR_HANDLE_4

Definition at line 79 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/DoorLock/inc/CC_DoorLock.h

Typedef Documentation#

door_lock_hw_data_t