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

Public Attributes#

uint8_t

Inside Door Handles Mode (4 bits)

uint8_t

Outside Door Handles Mode (4 bits)

uint8_t

Inside Door Handles State (4 bits)

uint8_t

Outside Door Handles State (4 bits)

uint8_t

Door condition (8 bits)

uint8_t

Lock Timeout Minutes, valid values 1-254 decimal.

uint8_t

Lock Timeout Seconds, valid 1-59 decimal.

Public Attribute Documentation#

mode#

door_lock_mode_t cc_door_lock_data_t::mode

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

type#

cc_door_lock_operation_type_t cc_door_lock_data_t::type

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

insideDoorHandleMode#

uint8_t cc_door_lock_data_t::insideDoorHandleMode

Inside Door Handles Mode (4 bits)


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

outsideDoorHandleMode#

uint8_t cc_door_lock_data_t::outsideDoorHandleMode

Outside Door Handles Mode (4 bits)


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

insideDoorHandleState#

uint8_t cc_door_lock_data_t::insideDoorHandleState

Inside Door Handles State (4 bits)


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

outsideDoorHandleState#

uint8_t cc_door_lock_data_t::outsideDoorHandleState

Outside Door Handles State (4 bits)


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

condition#

uint8_t cc_door_lock_data_t::condition

Door condition (8 bits)


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

lockTimeoutMin#

uint8_t cc_door_lock_data_t::lockTimeoutMin

Lock Timeout Minutes, valid values 1-254 decimal.


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

lockTimeoutSec#

uint8_t cc_door_lock_data_t::lockTimeoutSec

Lock Timeout Seconds, valid 1-59 decimal.


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