Door Lock Capabilities Report data structure.#

This allows the Application to inform the Command Class handler of the capabilities of the Door Lock.

The supportedOperationTypeBitmask field indicates the Supported Operations Modes:

  • Bit 0 in Bit Mask 1: Reserved

  • Bit 1 in Bit Mask 1: Constant Operation

  • Bit 2 in Bit Mask 1: Timed Operation.

The supportedDoorLockModeList indicates the Supported Door Lock Modes:

  • 0x00: Door Unsecured

  • 0x01: Door unsecured with timeout

  • 0x10: Door Unsecured for Inside Door Handles

  • 0x11: Door Unsecured for Inside Door Handles with timeout

  • 0x20: Door Unsecured for Outside Door Handles

  • 0x21: Door Unsecured for Outside Door Handles with timeout

  • 0xFF: Door Secured

Inside/outside Door Handles Modes supported These mode bits indicate which handles are supported on the Door Lock.

The mode of the four inside and four outside door handles are encoded in supportedInsideHandleModes and supportedOutsideHandleModes as:

  • Bit 0: Handle 1

  • Bit 1: Handle 2

  • Bit 2: Handle 3

  • Bit 3: Handle 4 Values:

  • 0: disabled

  • 1: enabled

Supported Door Components. The supportedDoorComponents field indicates the supported Door Lock components: such as bolt and latch states.

  • Bit 0: Door

  • Bit 1: Bolt

  • Bit 2: Latch

  • Bit 3-7: Reserved

Auto Relock Support The autoRelockSupport flag indicates if the Door Lock Supports Auto Relock (1=supported, 0=not supported).

Hold And Release Support The holdAndReleaseSupport flag indicates if the Door Lock Supports * Hold And Releaese (1=supported, 0=not supported),

Twist Assist Support The twistAssistSupport flag indicates if the Door Lock Supports Twist Assist (1=supported, 0=not supported),

Block To Block Support The blockToBlockSupport flag indicates if the Door Lock Supports Block To Block (1=supported, 0=not supported),

Public Attributes#

uint8_t
reserved

Reserved (2 bits)

uint8_t
lengthSupportedOperationType

Length of Supported Operation Type Bitmask (5 bits)

uint8_t
supportedOperationTypeBitmask

Supported Operation Types.

uint8_t
lengthSupportedDoorLockModeList

Length of supported Door Lock Mode List.

uint8_t
supportedDoorLockModeList

List of Supported Door Lock Modes.

uint8_t
supportedOutsideHandleModes

Supported Outside Handle Modes bitmask (4 bits)

uint8_t
supportedInsideHandleModes

Supported Inside Handle Modes bitmask (4 bits)

uint8_t
supportedDoorComponents

Supported Door Components.

uint8_t
autoRelockSupport

Indicates if the lock supports Auto Relock.

uint8_t
holdAndReleaseSupport

Indicates if the lock supports Hold And Release.

uint8_t
twistAssistSupport

Indicates if the lock supports Twist Assist.

uint8_t
blockToBlockSupport

Indicates if the lock supports Twist Assist.

Public Attribute Documentation#

reserved#

uint8_t cc_door_lock_capabilities_report_t::reserved

Reserved (2 bits)


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

lengthSupportedOperationType#

uint8_t cc_door_lock_capabilities_report_t::lengthSupportedOperationType

Length of Supported Operation Type Bitmask (5 bits)


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

supportedOperationTypeBitmask#

uint8_t cc_door_lock_capabilities_report_t::supportedOperationTypeBitmask

Supported Operation Types.

Max. length fixed to 1 byte. Enough to hold both defined types defined in SDS13781.


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

lengthSupportedDoorLockModeList#

uint8_t cc_door_lock_capabilities_report_t::lengthSupportedDoorLockModeList

Length of supported Door Lock Mode List.


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

supportedDoorLockModeList#

uint8_t cc_door_lock_capabilities_report_t::supportedDoorLockModeList[8]

List of Supported Door Lock Modes.

Max. Length fixed to 8 byte. Enough to hold all modes defined in SDS13781.


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

supportedOutsideHandleModes#

uint8_t cc_door_lock_capabilities_report_t::supportedOutsideHandleModes

Supported Outside Handle Modes bitmask (4 bits)


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

supportedInsideHandleModes#

uint8_t cc_door_lock_capabilities_report_t::supportedInsideHandleModes

Supported Inside Handle Modes bitmask (4 bits)


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

supportedDoorComponents#

uint8_t cc_door_lock_capabilities_report_t::supportedDoorComponents

Supported Door Components.


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

autoRelockSupport#

uint8_t cc_door_lock_capabilities_report_t::autoRelockSupport

Indicates if the lock supports Auto Relock.


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

holdAndReleaseSupport#

uint8_t cc_door_lock_capabilities_report_t::holdAndReleaseSupport

Indicates if the lock supports Hold And Release.


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

twistAssistSupport#

uint8_t cc_door_lock_capabilities_report_t::twistAssistSupport

Indicates if the lock supports Twist Assist.


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

blockToBlockSupport#

uint8_t cc_door_lock_capabilities_report_t::blockToBlockSupport

Indicates if the lock supports Twist Assist.


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