DoorLock#

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

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.

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.

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.

door_lock_hw_data_t#

typedef struct _door_lock_hw_data_t door_lock_hw_data_t

Physical components of Door Lock.

Structure follows but it's not limited to requirement CC:0062.04.03.11.006 Structure can be expanded with additional HW components.

cc_door_lock_latch_set#

void cc_door_lock_latch_set (bool opened)

Latch status handler.

Called when latch status is changed.

cc_door_lock_handle_set#

void cc_door_lock_handle_set (bool opened)

cc_door_lock_bolt_set#

void cc_door_lock_bolt_set (bool locked)

Bolt status handler.

Called when bolt status is changed.

CC_DoorLock_SetOutsideDoorHandleState#

void CC_DoorLock_SetOutsideDoorHandleState (cc_door_lock_handle_t handle)

Sets the Outside Door Handle State for a specific handle.

CC_DoorLock_ClearOutsideDoorHandleState#

void CC_DoorLock_ClearOutsideDoorHandleState (cc_door_lock_handle_t handle)

Clears the Outside Door Handle State for a specific handle.

cc_door_lock_mode_hw_change#

uint8_t cc_door_lock_mode_hw_change (door_lock_mode_t mode)

Initiates change on the hardware that changes door lock mode.

Can be called after operation has been triggered locally, or valid Operation Set command was received

Returns

• Remaining duration in seconds

door_lock_hw_bolt_is_unlocked#

bool door_lock_hw_bolt_is_unlocked (void)

Returns bolt state.

Returns

• True if unlocked, false if locked

door_lock_hw_latch_is_closed#

bool door_lock_hw_latch_is_closed (void)

Returns

door_lock_hw_handle_is_pressed#

bool door_lock_hw_handle_is_pressed (void)

Returns

cc_door_lock_get_operation_type#

cc_door_lock_operation_type_t cc_door_lock_get_operation_type (void)

cc_door_lock_get_supported_inside_handles#

cc_door_lock_handle_t cc_door_lock_get_supported_inside_handles (void)

cc_door_lock_get_supported_outside_handles#

cc_door_lock_handle_t cc_door_lock_get_supported_outside_handles (void)

cc_door_lock_get_options_flags#

uint8_t cc_door_lock_get_options_flags (void)

cc_door_lock_get_max_auto_relock_time#

uint16_t cc_door_lock_get_max_auto_relock_time (void)

cc_door_lock_get_max_hold_and_release_time#

uint16_t cc_door_lock_get_max_hold_and_release_time (void)

cc_door_lock_write#

bool cc_door_lock_write (cc_door_lock_data_t *door_lock_data)

cc_door_lock_read#

bool cc_door_lock_read (cc_door_lock_data_t *door_lock_data)

cc_door_lock_migrate#

void cc_door_lock_migrate (void)

DOOR_LOCK_OPERATION_SET_TIMEOUT_NOT_SUPPORTED#

#define DOOR_LOCK_OPERATION_SET_TIMEOUT_NOT_SUPPORTED

0xFE

Disabling Lock timeout minutes and seconds.