Trident IoT Z-Wave SDK
 
Loading...
Searching...
No Matches
cc_door_lock_capabilities_report_t Struct Reference

#include <CC_DoorLock.h>

Data Fields

uint8_t reserved: 3
 
uint8_t lengthSupportedOperationType: 5
 
uint8_t supportedOperationTypeBitmask
 
uint8_t lengthSupportedDoorLockModeList
 
uint8_t supportedDoorLockModeList [8]
 
uint8_t supportedOutsideHandleModes: 4
 
uint8_t supportedInsideHandleModes: 4
 
uint8_t supportedDoorComponents
 
uint8_t autoRelockSupport: 1
 
uint8_t holdAndReleaseSupport: 1
 
uint8_t twistAssistSupport: 1
 
uint8_t blockToBlockSupport: 1
 

Detailed Description

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),

Field Documentation

◆ autoRelockSupport

uint8_t cc_door_lock_capabilities_report_t::autoRelockSupport

Indicates if the lock supports Auto Relock

◆ blockToBlockSupport

uint8_t cc_door_lock_capabilities_report_t::blockToBlockSupport

Indicates if the lock supports Twist Assist

◆ holdAndReleaseSupport

uint8_t cc_door_lock_capabilities_report_t::holdAndReleaseSupport

Indicates if the lock supports Hold And Release

◆ lengthSupportedDoorLockModeList

uint8_t cc_door_lock_capabilities_report_t::lengthSupportedDoorLockModeList

Length of supported Door Lock Mode List.

◆ lengthSupportedOperationType

uint8_t cc_door_lock_capabilities_report_t::lengthSupportedOperationType

Length of Supported Operation Type Bitmask (5 bits)

◆ reserved

uint8_t cc_door_lock_capabilities_report_t::reserved

Reserved (2 bits)

◆ supportedDoorComponents

uint8_t cc_door_lock_capabilities_report_t::supportedDoorComponents

Supported Door Components

◆ 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.

◆ supportedInsideHandleModes

uint8_t cc_door_lock_capabilities_report_t::supportedInsideHandleModes

Supported Inside Handle Modes bitmask (4 bits)

◆ 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.

◆ supportedOutsideHandleModes

uint8_t cc_door_lock_capabilities_report_t::supportedOutsideHandleModes

Supported Outside Handle Modes bitmask (4 bits)

◆ twistAssistSupport

uint8_t cc_door_lock_capabilities_report_t::twistAssistSupport

Indicates if the lock supports Twist Assist


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