cc_door_lock_data_t Struct Reference

#include <CC_DoorLock.h>

Data Fields
door_lock_mode_t	mode
cc_door_lock_operation_type_t	type
uint8_t	insideDoorHandleMode: 4
uint8_t	outsideDoorHandleMode: 4
uint8_t	insideDoorHandleState: 4
uint8_t	outsideDoorHandleState: 4
uint8_t	condition
uint8_t	lockTimeoutMin
uint8_t	lockTimeoutSec

Detailed Description

Cmd Class Door Lock data structure.

• Inside/outside Door Handles Mode These mode bits indicate if the actual handle can open the door locally.

  The mode of the four inside and four outside door handles are encoded in insideDoorHandleMode and outsideDoorHandleMode as:

  • Bit 0: Handle 1
  • Bit 1: Handle 2
  • Bit 2: Handle 3
  • Bit 3: Handle 4
  • Values:
    • 0: disabled
    • 1: enabled
• Inside/outside Door Handles State These fields indicate if a door handle has been activated. The state of the four inside and four outside door handles are encoded in insideDoorHandleState and outsideDoorHandleState as follows:
  • Bit 0: Handle 1
  • Bit 1: Handle 2
  • Bit 2: Handle 3
  • Bit 3: Handle 4
  • Values:
    • 0: inactive
    • 1: activated

Note

Field condition is used only for saving data to NVM. For needs of Operation Report, this bitmask is calculated based on actual latch/bolt/door values. It's recommended to use door_lock_hw_data_t for hardware data.

Door condition. The condition field indicates the status of the door lock components such as bolt and latch states.

• Bit 0: Door
  • 0: Open
  • 1: Closed
• Bit 1: Bolt
  • 0: Locked
  • 1: Unlocked
• Bit 2: Latch
  • 0: Open
  • 1: Closed
• Bit 3-7: Reserved

Field Documentation

condition

uint8_t cc_door_lock_data_t::condition

Door condition (8 bits)

insideDoorHandleMode

uint8_t cc_door_lock_data_t::insideDoorHandleMode

Inside Door Handles Mode (4 bits)

insideDoorHandleState

uint8_t cc_door_lock_data_t::insideDoorHandleState

Inside Door Handles State (4 bits)

lockTimeoutMin

uint8_t cc_door_lock_data_t::lockTimeoutMin

Lock Timeout Minutes, valid values 1-254 decimal

lockTimeoutSec

uint8_t cc_door_lock_data_t::lockTimeoutSec

Lock Timeout Seconds, valid 1-59 decimal

mode

door_lock_mode_t cc_door_lock_data_t::mode

outsideDoorHandleMode

uint8_t cc_door_lock_data_t::outsideDoorHandleMode

Outside Door Handles Mode (4 bits)

outsideDoorHandleState

uint8_t cc_door_lock_data_t::outsideDoorHandleState

Outside Door Handles State (4 bits)

type

cc_door_lock_operation_type_t cc_door_lock_data_t::type

---

The documentation for this struct was generated from the following file:

• /sdk/z-wave/z-wave-stack/ZAF/CommandClasses/DoorLock/inc/CC_DoorLock.h