DoorLock

class st.zigbee.zcl.clusters.DoorLock
ID: number

0x0101 the ID of this cluster

NAME: str

“DoorLock” the name of this cluster

attributes: st.zigbee.zcl.clusters.DoorLockServerAttributes or st.zigbee.zcl.clusters.DoorLockClientAttributes
commands: st.zigbee.zcl.clusters.DoorLockServerCommands or st.zigbee.zcl.clusters.DoorLockClientCommands
types: st.zigbee.zcl.clusters.DoorLockTypes

DoorLock Attributes

class st.zigbee.zcl.clusters.DoorLock.LockState
ID: number

0x0000 the ID of this attribute

NAME: str

“LockState” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

NOT_FULLY_LOCKED: number

0

LOCKED: number

1

UNLOCKED: number

2

UNDEFINED: number

255

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Enum8) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Enum8 object of this attribute with any additional features provided for the attribute

This is also usable with the LockState(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Enum8

Return type:

st.zigbee.data_types.Enum8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.LockType
ID: number

0x0001 the ID of this attribute

NAME: str

“LockType” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

DEAD_BOLT: number

0

MAGNETIC: number

1

OTHER: number

2

MORTISE: number

3

RIM: number

4

LATCH_BOLT: number

5

CYLINDRICAL_LOCK: number

6

TUBULAR_LOCK: number

7

INTERCONNECTED_LOCK: number

8

DEAD_LATCH: number

9

DOOR_FURNITURE: number

10

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Enum8) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Enum8 object of this attribute with any additional features provided for the attribute

This is also usable with the LockType(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Enum8

Return type:

st.zigbee.data_types.Enum8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ActuatorEnabled
ID: number

0x0002 the ID of this attribute

NAME: str

“ActuatorEnabled” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the ActuatorEnabled(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.DoorState
ID: number

0x0003 the ID of this attribute

NAME: str

“DoorState” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

OPEN: number

0

CLOSED: number

1

ERROR_JAMMED: number

2

ERROR_FORCED_OPEN: number

3

ERROR_UNSPECIFIED: number

4

UNDEFINED: number

255

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Enum8) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Enum8 object of this attribute with any additional features provided for the attribute

This is also usable with the DoorState(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Enum8

Return type:

st.zigbee.data_types.Enum8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.DoorOpenEvents
ID: number

0x0004 the ID of this attribute

NAME: str

“DoorOpenEvents” the name of this attribute

data_type: st.zigbee.data_types.Uint32

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the DoorOpenEvents(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint32

Return type:

st.zigbee.data_types.Uint32

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint32) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.DoorClosedEvents
ID: number

0x0005 the ID of this attribute

NAME: str

“DoorClosedEvents” the name of this attribute

data_type: st.zigbee.data_types.Uint32

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the DoorClosedEvents(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint32

Return type:

st.zigbee.data_types.Uint32

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint32) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.OpenPeriod
ID: number

0x0006 the ID of this attribute

NAME: str

“OpenPeriod” the name of this attribute

data_type: st.zigbee.data_types.Uint16

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the OpenPeriod(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.NumberOfLogRecordsSupported
ID: number

0x0010 the ID of this attribute

NAME: str

“NumberOfLogRecordsSupported” the name of this attribute

data_type: st.zigbee.data_types.Uint16

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfLogRecordsSupported(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.NumberOfTotalUsersSupported
ID: number

0x0011 the ID of this attribute

NAME: str

“NumberOfTotalUsersSupported” the name of this attribute

data_type: st.zigbee.data_types.Uint16

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfTotalUsersSupported(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.NumberOfPINUsersSupported
ID: number

0x0012 the ID of this attribute

NAME: str

“NumberOfPINUsersSupported” the name of this attribute

data_type: st.zigbee.data_types.Uint16

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfPINUsersSupported(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.NumberOfRFIDUsersSupported
ID: number

0x0013 the ID of this attribute

NAME: str

“NumberOfRFIDUsersSupported” the name of this attribute

data_type: st.zigbee.data_types.Uint16

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfRFIDUsersSupported(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.NumberOfWeekDaySchedulesSupportedPerUser
ID: number

0x0014 the ID of this attribute

NAME: str

“NumberOfWeekDaySchedulesSupportedPerUser” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfWeekDaySchedulesSupportedPerUser(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.NumberOfYearDaySchedulesSupportedPerUser
ID: number

0x0015 the ID of this attribute

NAME: str

“NumberOfYearDaySchedulesSupportedPerUser” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfYearDaySchedulesSupportedPerUser(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.NumberOfHolidaySchedulesSupported
ID: number

0x0016 the ID of this attribute

NAME: str

“NumberOfHolidaySchedulesSupported” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the NumberOfHolidaySchedulesSupported(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.MaxPINCodeLength
ID: number

0x0017 the ID of this attribute

NAME: str

“MaxPINCodeLength” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the MaxPINCodeLength(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.MinPINCodeLength
ID: number

0x0018 the ID of this attribute

NAME: str

“MinPINCodeLength” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the MinPINCodeLength(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.MaxRFIDCodeLength
ID: number

0x0019 the ID of this attribute

NAME: str

“MaxRFIDCodeLength” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the MaxRFIDCodeLength(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.MinRFIDCodeLength
ID: number

0x001A the ID of this attribute

NAME: str

“MinRFIDCodeLength” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the MinRFIDCodeLength(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.EnableLogging
ID: number

0x0020 the ID of this attribute

NAME: str

“EnableLogging” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the EnableLogging(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.Language
ID: number

0x0021 the ID of this attribute

NAME: str

“Language” the name of this attribute

data_type: st.zigbee.data_types.CharString

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a CharString object of this attribute with any additional features provided for the attribute

This is also usable with the Language(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a CharString

Return type:

st.zigbee.data_types.CharString

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.CharString) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.LEDSettings
ID: number

0x0022 the ID of this attribute

NAME: str

“LEDSettings” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

NEVER_USE_LED: number

0

USE_LED_EXCEPT_FOR_ACCESS_ALLOWED: number

1

USE_LED_FOR_ALL_EVENTS: number

2

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Uint8) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the LEDSettings(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.AutoRelockTime
ID: number

0x0023 the ID of this attribute

NAME: str

“AutoRelockTime” the name of this attribute

data_type: st.zigbee.data_types.Uint32

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the AutoRelockTime(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint32

Return type:

st.zigbee.data_types.Uint32

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint32) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.SoundVolume
ID: number

0x0024 the ID of this attribute

NAME: str

“SoundVolume” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

SILENT_MODE: number

0

LOW_VOLUME: number

1

HIGH_VOLUME: number

2

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Uint8) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the SoundVolume(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.OperatingMode
ID: number

0x0025 the ID of this attribute

NAME: str

“OperatingMode” the name of this attribute

data_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkOperatingMode

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a DrlkOperatingModeType object of this attribute with any additional features provided for the attribute

This is also usable with the OperatingMode(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a DrlkOperatingModeType

Return type:

st.zigbee.zcl.clusters.DoorLock.types.DrlkOperatingMode

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.zcl.clusters.DoorLock.types.DrlkOperatingMode) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.SupportedOperatingModes
ID: number

0x0026 the ID of this attribute

NAME: str

“SupportedOperatingModes” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

NORMAL_MODE_SUPPORTED: number

1

VACATION_MODE_SUPPORTED: number

2

PRIVACY_MODE_SUPPORTED: number

4

NO_RF_LOCK_OR_UNLOCK_MODE_SUPPORTED: number

8

PASSAGE_MODE_SUPPORTED: number

16

is_normal_mode_supported_set()
Returns:

True if the value of NORMAL_MODE_SUPPORTED is non-zero

Return type:

boolean

set_normal_mode_supported()

Set the value of the bit in the NORMAL_MODE_SUPPORTED field to 1

unset_normal_mode_supported()

Set the value of the bits in the NORMAL_MODE_SUPPORTED field to 0

is_vacation_mode_supported_set()
Returns:

True if the value of VACATION_MODE_SUPPORTED is non-zero

Return type:

boolean

set_vacation_mode_supported()

Set the value of the bit in the VACATION_MODE_SUPPORTED field to 1

unset_vacation_mode_supported()

Set the value of the bits in the VACATION_MODE_SUPPORTED field to 0

is_privacy_mode_supported_set()
Returns:

True if the value of PRIVACY_MODE_SUPPORTED is non-zero

Return type:

boolean

set_privacy_mode_supported()

Set the value of the bit in the PRIVACY_MODE_SUPPORTED field to 1

unset_privacy_mode_supported()

Set the value of the bits in the PRIVACY_MODE_SUPPORTED field to 0

is_no_rf_lock_or_unlock_mode_supported_set()
Returns:

True if the value of NO_RF_LOCK_OR_UNLOCK_MODE_SUPPORTED is non-zero

Return type:

boolean

set_no_rf_lock_or_unlock_mode_supported()

Set the value of the bit in the NO_RF_LOCK_OR_UNLOCK_MODE_SUPPORTED field to 1

unset_no_rf_lock_or_unlock_mode_supported()

Set the value of the bits in the NO_RF_LOCK_OR_UNLOCK_MODE_SUPPORTED field to 0

is_passage_mode_supported_set()
Returns:

True if the value of PASSAGE_MODE_SUPPORTED is non-zero

Return type:

boolean

set_passage_mode_supported()

Set the value of the bit in the PASSAGE_MODE_SUPPORTED field to 1

unset_passage_mode_supported()

Set the value of the bits in the PASSAGE_MODE_SUPPORTED field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the SupportedOperatingModes(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.DefaultConfigurationRegister
ID: number

0x0027 the ID of this attribute

NAME: str

“DefaultConfigurationRegister” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

DEFAULT_ENABLE_LOCAL_PROGRAMMING_ATTRIBUTE_IS_ENABLED: number

1

DEFAULT_KEYPAD_INTERFACE_IS_ENABLED: number

2

DEFAULT_RF_INTERFACE_IS_ENABLED: number

4

DEFAULT_SOUND_VOLUME_IS_ENABLED: number

32

DEFAULT_AUTO_RELOCK_TIME_IS_ENABLED: number

64

DEFAULT_LED_SETTINGS_IS_ENABLED: number

128

is_default_enable_local_programming_attribute_is_enabled_set()
Returns:

True if the value of DEFAULT_ENABLE_LOCAL_PROGRAMMING_ATTRIBUTE_IS_ENABLED is non-zero

Return type:

boolean

set_default_enable_local_programming_attribute_is_enabled()

Set the value of the bit in the DEFAULT_ENABLE_LOCAL_PROGRAMMING_ATTRIBUTE_IS_ENABLED field to 1

unset_default_enable_local_programming_attribute_is_enabled()

Set the value of the bits in the DEFAULT_ENABLE_LOCAL_PROGRAMMING_ATTRIBUTE_IS_ENABLED field to 0

is_default_keypad_interface_is_enabled_set()
Returns:

True if the value of DEFAULT_KEYPAD_INTERFACE_IS_ENABLED is non-zero

Return type:

boolean

set_default_keypad_interface_is_enabled()

Set the value of the bit in the DEFAULT_KEYPAD_INTERFACE_IS_ENABLED field to 1

unset_default_keypad_interface_is_enabled()

Set the value of the bits in the DEFAULT_KEYPAD_INTERFACE_IS_ENABLED field to 0

is_default_rf_interface_is_enabled_set()
Returns:

True if the value of DEFAULT_RF_INTERFACE_IS_ENABLED is non-zero

Return type:

boolean

set_default_rf_interface_is_enabled()

Set the value of the bit in the DEFAULT_RF_INTERFACE_IS_ENABLED field to 1

unset_default_rf_interface_is_enabled()

Set the value of the bits in the DEFAULT_RF_INTERFACE_IS_ENABLED field to 0

is_default_sound_volume_is_enabled_set()
Returns:

True if the value of DEFAULT_SOUND_VOLUME_IS_ENABLED is non-zero

Return type:

boolean

set_default_sound_volume_is_enabled()

Set the value of the bit in the DEFAULT_SOUND_VOLUME_IS_ENABLED field to 1

unset_default_sound_volume_is_enabled()

Set the value of the bits in the DEFAULT_SOUND_VOLUME_IS_ENABLED field to 0

is_default_auto_relock_time_is_enabled_set()
Returns:

True if the value of DEFAULT_AUTO_RELOCK_TIME_IS_ENABLED is non-zero

Return type:

boolean

set_default_auto_relock_time_is_enabled()

Set the value of the bit in the DEFAULT_AUTO_RELOCK_TIME_IS_ENABLED field to 1

unset_default_auto_relock_time_is_enabled()

Set the value of the bits in the DEFAULT_AUTO_RELOCK_TIME_IS_ENABLED field to 0

is_default_led_settings_is_enabled_set()
Returns:

True if the value of DEFAULT_LED_SETTINGS_IS_ENABLED is non-zero

Return type:

boolean

set_default_led_settings_is_enabled()

Set the value of the bit in the DEFAULT_LED_SETTINGS_IS_ENABLED field to 1

unset_default_led_settings_is_enabled()

Set the value of the bits in the DEFAULT_LED_SETTINGS_IS_ENABLED field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the DefaultConfigurationRegister(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.EnableLocalProgramming
ID: number

0x0028 the ID of this attribute

NAME: str

“EnableLocalProgramming” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the EnableLocalProgramming(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.EnableOneTouchLocking
ID: number

0x0029 the ID of this attribute

NAME: str

“EnableOneTouchLocking” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the EnableOneTouchLocking(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.EnableInsideStatusLED
ID: number

0x002A the ID of this attribute

NAME: str

“EnableInsideStatusLED” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the EnableInsideStatusLED(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.EnablePrivacyModeButton
ID: number

0x002B the ID of this attribute

NAME: str

“EnablePrivacyModeButton” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the EnablePrivacyModeButton(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.WrongCodeEntryLimit
ID: number

0x0030 the ID of this attribute

NAME: str

“WrongCodeEntryLimit” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the WrongCodeEntryLimit(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.UserCodeTemporaryDisableTime
ID: number

0x0031 the ID of this attribute

NAME: str

“UserCodeTemporaryDisableTime” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the UserCodeTemporaryDisableTime(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint8

Return type:

st.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.SendPINOverTheAir
ID: number

0x0032 the ID of this attribute

NAME: str

“SendPINOverTheAir” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the SendPINOverTheAir(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.RequirePINforRFOperation
ID: number

0x0033 the ID of this attribute

NAME: str

“RequirePINforRFOperation” the name of this attribute

data_type: st.zigbee.data_types.Boolean

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Boolean object of this attribute with any additional features provided for the attribute

This is also usable with the RequirePINforRFOperation(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Boolean

Return type:

st.zigbee.data_types.Boolean

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.SecurityLevel
ID: number

0x0034 the ID of this attribute

NAME: str

“SecurityLevel” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

NETWORK: number

0

APS: number

1

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Enum8) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Enum8 object of this attribute with any additional features provided for the attribute

This is also usable with the SecurityLevel(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Enum8

Return type:

st.zigbee.data_types.Enum8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.AlarmMask
ID: number

0x0040 the ID of this attribute

NAME: str

“AlarmMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

DEADBOLT_JAMMED: number

1

LOCK_RESET_TO_FACTORY_DEFAULTS: number

2

RF_POWER_MODULE_CYCLED: number

8

TAMPER_ALARM_WRONG_CODE_ENTRY_LIMIT: number

16

TAMPER_ALARM_FRONT_ESCUTCHEON_REMOVED_FROM_MAIN: number

32

FORCED_DOOR_OPEN_UNDER_DOOR_LOCKED_CONDITION: number

64

is_deadbolt_jammed_set()
Returns:

True if the value of DEADBOLT_JAMMED is non-zero

Return type:

boolean

set_deadbolt_jammed()

Set the value of the bit in the DEADBOLT_JAMMED field to 1

unset_deadbolt_jammed()

Set the value of the bits in the DEADBOLT_JAMMED field to 0

is_lock_reset_to_factory_defaults_set()
Returns:

True if the value of LOCK_RESET_TO_FACTORY_DEFAULTS is non-zero

Return type:

boolean

set_lock_reset_to_factory_defaults()

Set the value of the bit in the LOCK_RESET_TO_FACTORY_DEFAULTS field to 1

unset_lock_reset_to_factory_defaults()

Set the value of the bits in the LOCK_RESET_TO_FACTORY_DEFAULTS field to 0

is_rf_power_module_cycled_set()
Returns:

True if the value of RF_POWER_MODULE_CYCLED is non-zero

Return type:

boolean

set_rf_power_module_cycled()

Set the value of the bit in the RF_POWER_MODULE_CYCLED field to 1

unset_rf_power_module_cycled()

Set the value of the bits in the RF_POWER_MODULE_CYCLED field to 0

is_tamper_alarm_wrong_code_entry_limit_set()
Returns:

True if the value of TAMPER_ALARM_WRONG_CODE_ENTRY_LIMIT is non-zero

Return type:

boolean

set_tamper_alarm_wrong_code_entry_limit()

Set the value of the bit in the TAMPER_ALARM_WRONG_CODE_ENTRY_LIMIT field to 1

unset_tamper_alarm_wrong_code_entry_limit()

Set the value of the bits in the TAMPER_ALARM_WRONG_CODE_ENTRY_LIMIT field to 0

is_tamper_alarm_front_escutcheon_removed_from_main_set()
Returns:

True if the value of TAMPER_ALARM_FRONT_ESCUTCHEON_REMOVED_FROM_MAIN is non-zero

Return type:

boolean

set_tamper_alarm_front_escutcheon_removed_from_main()

Set the value of the bit in the TAMPER_ALARM_FRONT_ESCUTCHEON_REMOVED_FROM_MAIN field to 1

unset_tamper_alarm_front_escutcheon_removed_from_main()

Set the value of the bits in the TAMPER_ALARM_FRONT_ESCUTCHEON_REMOVED_FROM_MAIN field to 0

is_forced_door_open_under_door_locked_condition_set()
Returns:

True if the value of FORCED_DOOR_OPEN_UNDER_DOOR_LOCKED_CONDITION is non-zero

Return type:

boolean

set_forced_door_open_under_door_locked_condition()

Set the value of the bit in the FORCED_DOOR_OPEN_UNDER_DOOR_LOCKED_CONDITION field to 1

unset_forced_door_open_under_door_locked_condition()

Set the value of the bits in the FORCED_DOOR_OPEN_UNDER_DOOR_LOCKED_CONDITION field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the AlarmMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.KeypadOperationEventMask
ID: number

0x0041 the ID of this attribute

NAME: str

“KeypadOperationEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

KEYPAD_OP_UNKNOWN_OR_MS: number

1

KEYPAD_OP_LOCK: number

2

KEYPAD_OP_UNLOCK: number

4

KEYPAD_OP_LOCK_ERROR_INVALID_PIN: number

8

KEYPAD_OP_LOCK_ERROR_INVALID_SCHEDULE: number

16

KEYPAD_OP_UNLOCK_INVALID_PIN: number

32

KEYPAD_OP_UNLOCK_INVALID_SCHEDULE: number

64

KEYPAD_OP_NON_ACCESS_USER: number

128

is_keypad_op_unknown_or_ms_set()
Returns:

True if the value of KEYPAD_OP_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_keypad_op_unknown_or_ms()

Set the value of the bit in the KEYPAD_OP_UNKNOWN_OR_MS field to 1

unset_keypad_op_unknown_or_ms()

Set the value of the bits in the KEYPAD_OP_UNKNOWN_OR_MS field to 0

is_keypad_op_lock_set()
Returns:

True if the value of KEYPAD_OP_LOCK is non-zero

Return type:

boolean

set_keypad_op_lock()

Set the value of the bit in the KEYPAD_OP_LOCK field to 1

unset_keypad_op_lock()

Set the value of the bits in the KEYPAD_OP_LOCK field to 0

is_keypad_op_unlock_set()
Returns:

True if the value of KEYPAD_OP_UNLOCK is non-zero

Return type:

boolean

set_keypad_op_unlock()

Set the value of the bit in the KEYPAD_OP_UNLOCK field to 1

unset_keypad_op_unlock()

Set the value of the bits in the KEYPAD_OP_UNLOCK field to 0

is_keypad_op_lock_error_invalid_pin_set()
Returns:

True if the value of KEYPAD_OP_LOCK_ERROR_INVALID_PIN is non-zero

Return type:

boolean

set_keypad_op_lock_error_invalid_pin()

Set the value of the bit in the KEYPAD_OP_LOCK_ERROR_INVALID_PIN field to 1

unset_keypad_op_lock_error_invalid_pin()

Set the value of the bits in the KEYPAD_OP_LOCK_ERROR_INVALID_PIN field to 0

is_keypad_op_lock_error_invalid_schedule_set()
Returns:

True if the value of KEYPAD_OP_LOCK_ERROR_INVALID_SCHEDULE is non-zero

Return type:

boolean

set_keypad_op_lock_error_invalid_schedule()

Set the value of the bit in the KEYPAD_OP_LOCK_ERROR_INVALID_SCHEDULE field to 1

unset_keypad_op_lock_error_invalid_schedule()

Set the value of the bits in the KEYPAD_OP_LOCK_ERROR_INVALID_SCHEDULE field to 0

is_keypad_op_unlock_invalid_pin_set()
Returns:

True if the value of KEYPAD_OP_UNLOCK_INVALID_PIN is non-zero

Return type:

boolean

set_keypad_op_unlock_invalid_pin()

Set the value of the bit in the KEYPAD_OP_UNLOCK_INVALID_PIN field to 1

unset_keypad_op_unlock_invalid_pin()

Set the value of the bits in the KEYPAD_OP_UNLOCK_INVALID_PIN field to 0

is_keypad_op_unlock_invalid_schedule_set()
Returns:

True if the value of KEYPAD_OP_UNLOCK_INVALID_SCHEDULE is non-zero

Return type:

boolean

set_keypad_op_unlock_invalid_schedule()

Set the value of the bit in the KEYPAD_OP_UNLOCK_INVALID_SCHEDULE field to 1

unset_keypad_op_unlock_invalid_schedule()

Set the value of the bits in the KEYPAD_OP_UNLOCK_INVALID_SCHEDULE field to 0

is_keypad_op_non_access_user_set()
Returns:

True if the value of KEYPAD_OP_NON_ACCESS_USER is non-zero

Return type:

boolean

set_keypad_op_non_access_user()

Set the value of the bit in the KEYPAD_OP_NON_ACCESS_USER field to 1

unset_keypad_op_non_access_user()

Set the value of the bits in the KEYPAD_OP_NON_ACCESS_USER field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the KeypadOperationEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.RFOperationEventMask
ID: number

0x0042 the ID of this attribute

NAME: str

“RFOperationEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

RF_OP_UNKNOWN_OR_MS: number

1

RF_OP_LOCK: number

2

RF_OP_UNLOCK: number

4

RF_OP_LOCK_ERROR_INVALID_CODE: number

8

RF_OP_LOCK_ERROR_INVALID_SCHEDULE: number

16

RF_OP_UNLOCK_INVALID_CODE: number

32

RF_OP_UNLOCK_INVALID_SCHEDULE: number

64

is_rf_op_unknown_or_ms_set()
Returns:

True if the value of RF_OP_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_rf_op_unknown_or_ms()

Set the value of the bit in the RF_OP_UNKNOWN_OR_MS field to 1

unset_rf_op_unknown_or_ms()

Set the value of the bits in the RF_OP_UNKNOWN_OR_MS field to 0

is_rf_op_lock_set()
Returns:

True if the value of RF_OP_LOCK is non-zero

Return type:

boolean

set_rf_op_lock()

Set the value of the bit in the RF_OP_LOCK field to 1

unset_rf_op_lock()

Set the value of the bits in the RF_OP_LOCK field to 0

is_rf_op_unlock_set()
Returns:

True if the value of RF_OP_UNLOCK is non-zero

Return type:

boolean

set_rf_op_unlock()

Set the value of the bit in the RF_OP_UNLOCK field to 1

unset_rf_op_unlock()

Set the value of the bits in the RF_OP_UNLOCK field to 0

is_rf_op_lock_error_invalid_code_set()
Returns:

True if the value of RF_OP_LOCK_ERROR_INVALID_CODE is non-zero

Return type:

boolean

set_rf_op_lock_error_invalid_code()

Set the value of the bit in the RF_OP_LOCK_ERROR_INVALID_CODE field to 1

unset_rf_op_lock_error_invalid_code()

Set the value of the bits in the RF_OP_LOCK_ERROR_INVALID_CODE field to 0

is_rf_op_lock_error_invalid_schedule_set()
Returns:

True if the value of RF_OP_LOCK_ERROR_INVALID_SCHEDULE is non-zero

Return type:

boolean

set_rf_op_lock_error_invalid_schedule()

Set the value of the bit in the RF_OP_LOCK_ERROR_INVALID_SCHEDULE field to 1

unset_rf_op_lock_error_invalid_schedule()

Set the value of the bits in the RF_OP_LOCK_ERROR_INVALID_SCHEDULE field to 0

is_rf_op_unlock_invalid_code_set()
Returns:

True if the value of RF_OP_UNLOCK_INVALID_CODE is non-zero

Return type:

boolean

set_rf_op_unlock_invalid_code()

Set the value of the bit in the RF_OP_UNLOCK_INVALID_CODE field to 1

unset_rf_op_unlock_invalid_code()

Set the value of the bits in the RF_OP_UNLOCK_INVALID_CODE field to 0

is_rf_op_unlock_invalid_schedule_set()
Returns:

True if the value of RF_OP_UNLOCK_INVALID_SCHEDULE is non-zero

Return type:

boolean

set_rf_op_unlock_invalid_schedule()

Set the value of the bit in the RF_OP_UNLOCK_INVALID_SCHEDULE field to 1

unset_rf_op_unlock_invalid_schedule()

Set the value of the bits in the RF_OP_UNLOCK_INVALID_SCHEDULE field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the RFOperationEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.ManualOperationEventMask
ID: number

0x0043 the ID of this attribute

NAME: str

“ManualOperationEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

MANUAL_OP_UNKNOWN_OR_MS: number

1

MANUAL_OP_THUMBTURN_LOCK: number

2

MANUAL_OP_THUMBTURN_UNLOCK: number

4

MANUAL_OP_ONE_TOUCH_LOCK: number

8

MANUAL_OP_KEY_LOCK: number

16

MANUAL_OP_KEY_UNLOCK: number

32

MANUAL_OP_AUTO_LOCK: number

64

MANUAL_OP_SCHEDULE_LOCK: number

128

MANUAL_OP_SCHEDULE_UNLOCK: number

256

MANUAL_OP_LOCK: number

512

MANUAL_OP_UNLOCK: number

1024

is_manual_op_unknown_or_ms_set()
Returns:

True if the value of MANUAL_OP_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_manual_op_unknown_or_ms()

Set the value of the bit in the MANUAL_OP_UNKNOWN_OR_MS field to 1

unset_manual_op_unknown_or_ms()

Set the value of the bits in the MANUAL_OP_UNKNOWN_OR_MS field to 0

is_manual_op_thumbturn_lock_set()
Returns:

True if the value of MANUAL_OP_THUMBTURN_LOCK is non-zero

Return type:

boolean

set_manual_op_thumbturn_lock()

Set the value of the bit in the MANUAL_OP_THUMBTURN_LOCK field to 1

unset_manual_op_thumbturn_lock()

Set the value of the bits in the MANUAL_OP_THUMBTURN_LOCK field to 0

is_manual_op_thumbturn_unlock_set()
Returns:

True if the value of MANUAL_OP_THUMBTURN_UNLOCK is non-zero

Return type:

boolean

set_manual_op_thumbturn_unlock()

Set the value of the bit in the MANUAL_OP_THUMBTURN_UNLOCK field to 1

unset_manual_op_thumbturn_unlock()

Set the value of the bits in the MANUAL_OP_THUMBTURN_UNLOCK field to 0

is_manual_op_one_touch_lock_set()
Returns:

True if the value of MANUAL_OP_ONE_TOUCH_LOCK is non-zero

Return type:

boolean

set_manual_op_one_touch_lock()

Set the value of the bit in the MANUAL_OP_ONE_TOUCH_LOCK field to 1

unset_manual_op_one_touch_lock()

Set the value of the bits in the MANUAL_OP_ONE_TOUCH_LOCK field to 0

is_manual_op_key_lock_set()
Returns:

True if the value of MANUAL_OP_KEY_LOCK is non-zero

Return type:

boolean

set_manual_op_key_lock()

Set the value of the bit in the MANUAL_OP_KEY_LOCK field to 1

unset_manual_op_key_lock()

Set the value of the bits in the MANUAL_OP_KEY_LOCK field to 0

is_manual_op_key_unlock_set()
Returns:

True if the value of MANUAL_OP_KEY_UNLOCK is non-zero

Return type:

boolean

set_manual_op_key_unlock()

Set the value of the bit in the MANUAL_OP_KEY_UNLOCK field to 1

unset_manual_op_key_unlock()

Set the value of the bits in the MANUAL_OP_KEY_UNLOCK field to 0

is_manual_op_auto_lock_set()
Returns:

True if the value of MANUAL_OP_AUTO_LOCK is non-zero

Return type:

boolean

set_manual_op_auto_lock()

Set the value of the bit in the MANUAL_OP_AUTO_LOCK field to 1

unset_manual_op_auto_lock()

Set the value of the bits in the MANUAL_OP_AUTO_LOCK field to 0

is_manual_op_schedule_lock_set()
Returns:

True if the value of MANUAL_OP_SCHEDULE_LOCK is non-zero

Return type:

boolean

set_manual_op_schedule_lock()

Set the value of the bit in the MANUAL_OP_SCHEDULE_LOCK field to 1

unset_manual_op_schedule_lock()

Set the value of the bits in the MANUAL_OP_SCHEDULE_LOCK field to 0

is_manual_op_schedule_unlock_set()
Returns:

True if the value of MANUAL_OP_SCHEDULE_UNLOCK is non-zero

Return type:

boolean

set_manual_op_schedule_unlock()

Set the value of the bit in the MANUAL_OP_SCHEDULE_UNLOCK field to 1

unset_manual_op_schedule_unlock()

Set the value of the bits in the MANUAL_OP_SCHEDULE_UNLOCK field to 0

is_manual_op_lock_set()
Returns:

True if the value of MANUAL_OP_LOCK is non-zero

Return type:

boolean

set_manual_op_lock()

Set the value of the bit in the MANUAL_OP_LOCK field to 1

unset_manual_op_lock()

Set the value of the bits in the MANUAL_OP_LOCK field to 0

is_manual_op_unlock_set()
Returns:

True if the value of MANUAL_OP_UNLOCK is non-zero

Return type:

boolean

set_manual_op_unlock()

Set the value of the bit in the MANUAL_OP_UNLOCK field to 1

unset_manual_op_unlock()

Set the value of the bits in the MANUAL_OP_UNLOCK field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the ManualOperationEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.RFIDOperationEventMask
ID: number

0x0044 the ID of this attribute

NAME: str

“RFIDOperationEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

RFID_OP_UNKNOWN_OR_MS: number

1

RFID_OP_LOCK: number

2

RFID_OP_UNLOCK: number

4

RFID_OP_LOCK_ERROR_INVALID_RFID: number

8

RFID_OP_LOCK_ERROR_INVALID_SCHEDULE: number

16

RFID_OP_UNLOCK_ERROR_INVALID_RFID: number

32

RFID_OP_UNLOCK_ERROR_INVALID_SCHEDULE: number

64

is_rfid_op_unknown_or_ms_set()
Returns:

True if the value of RFID_OP_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_rfid_op_unknown_or_ms()

Set the value of the bit in the RFID_OP_UNKNOWN_OR_MS field to 1

unset_rfid_op_unknown_or_ms()

Set the value of the bits in the RFID_OP_UNKNOWN_OR_MS field to 0

is_rfid_op_lock_set()
Returns:

True if the value of RFID_OP_LOCK is non-zero

Return type:

boolean

set_rfid_op_lock()

Set the value of the bit in the RFID_OP_LOCK field to 1

unset_rfid_op_lock()

Set the value of the bits in the RFID_OP_LOCK field to 0

is_rfid_op_unlock_set()
Returns:

True if the value of RFID_OP_UNLOCK is non-zero

Return type:

boolean

set_rfid_op_unlock()

Set the value of the bit in the RFID_OP_UNLOCK field to 1

unset_rfid_op_unlock()

Set the value of the bits in the RFID_OP_UNLOCK field to 0

is_rfid_op_lock_error_invalid_rfid_set()
Returns:

True if the value of RFID_OP_LOCK_ERROR_INVALID_RFID is non-zero

Return type:

boolean

set_rfid_op_lock_error_invalid_rfid()

Set the value of the bit in the RFID_OP_LOCK_ERROR_INVALID_RFID field to 1

unset_rfid_op_lock_error_invalid_rfid()

Set the value of the bits in the RFID_OP_LOCK_ERROR_INVALID_RFID field to 0

is_rfid_op_lock_error_invalid_schedule_set()
Returns:

True if the value of RFID_OP_LOCK_ERROR_INVALID_SCHEDULE is non-zero

Return type:

boolean

set_rfid_op_lock_error_invalid_schedule()

Set the value of the bit in the RFID_OP_LOCK_ERROR_INVALID_SCHEDULE field to 1

unset_rfid_op_lock_error_invalid_schedule()

Set the value of the bits in the RFID_OP_LOCK_ERROR_INVALID_SCHEDULE field to 0

is_rfid_op_unlock_error_invalid_rfid_set()
Returns:

True if the value of RFID_OP_UNLOCK_ERROR_INVALID_RFID is non-zero

Return type:

boolean

set_rfid_op_unlock_error_invalid_rfid()

Set the value of the bit in the RFID_OP_UNLOCK_ERROR_INVALID_RFID field to 1

unset_rfid_op_unlock_error_invalid_rfid()

Set the value of the bits in the RFID_OP_UNLOCK_ERROR_INVALID_RFID field to 0

is_rfid_op_unlock_error_invalid_schedule_set()
Returns:

True if the value of RFID_OP_UNLOCK_ERROR_INVALID_SCHEDULE is non-zero

Return type:

boolean

set_rfid_op_unlock_error_invalid_schedule()

Set the value of the bit in the RFID_OP_UNLOCK_ERROR_INVALID_SCHEDULE field to 1

unset_rfid_op_unlock_error_invalid_schedule()

Set the value of the bits in the RFID_OP_UNLOCK_ERROR_INVALID_SCHEDULE field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the RFIDOperationEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.KeypadProgrammingEventMask
ID: number

0x0045 the ID of this attribute

NAME: str

“KeypadProgrammingEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

KEYPAD_PROG_UNKNOWN_OR_MS: number

1

KEYPAD_PROG_MASTER_CODE_CHANGED: number

2

KEYPAD_PROG_PIN_ADDED: number

4

KEYPAD_PROG_PIN_DELETED: number

8

KEYPAD_PROG_PIN_CHANGED: number

16

is_keypad_prog_unknown_or_ms_set()
Returns:

True if the value of KEYPAD_PROG_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_keypad_prog_unknown_or_ms()

Set the value of the bit in the KEYPAD_PROG_UNKNOWN_OR_MS field to 1

unset_keypad_prog_unknown_or_ms()

Set the value of the bits in the KEYPAD_PROG_UNKNOWN_OR_MS field to 0

is_keypad_prog_master_code_changed_set()
Returns:

True if the value of KEYPAD_PROG_MASTER_CODE_CHANGED is non-zero

Return type:

boolean

set_keypad_prog_master_code_changed()

Set the value of the bit in the KEYPAD_PROG_MASTER_CODE_CHANGED field to 1

unset_keypad_prog_master_code_changed()

Set the value of the bits in the KEYPAD_PROG_MASTER_CODE_CHANGED field to 0

is_keypad_prog_pin_added_set()
Returns:

True if the value of KEYPAD_PROG_PIN_ADDED is non-zero

Return type:

boolean

set_keypad_prog_pin_added()

Set the value of the bit in the KEYPAD_PROG_PIN_ADDED field to 1

unset_keypad_prog_pin_added()

Set the value of the bits in the KEYPAD_PROG_PIN_ADDED field to 0

is_keypad_prog_pin_deleted_set()
Returns:

True if the value of KEYPAD_PROG_PIN_DELETED is non-zero

Return type:

boolean

set_keypad_prog_pin_deleted()

Set the value of the bit in the KEYPAD_PROG_PIN_DELETED field to 1

unset_keypad_prog_pin_deleted()

Set the value of the bits in the KEYPAD_PROG_PIN_DELETED field to 0

is_keypad_prog_pin_changed_set()
Returns:

True if the value of KEYPAD_PROG_PIN_CHANGED is non-zero

Return type:

boolean

set_keypad_prog_pin_changed()

Set the value of the bit in the KEYPAD_PROG_PIN_CHANGED field to 1

unset_keypad_prog_pin_changed()

Set the value of the bits in the KEYPAD_PROG_PIN_CHANGED field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the KeypadProgrammingEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.RFProgrammingEventMask
ID: number

0x0046 the ID of this attribute

NAME: str

“RFProgrammingEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

RF_PROG_UNKNOWN_OR_MS: number

1

RF_PROG_PIN_ADDED: number

4

RF_PROG_PIN_DELETED: number

8

RF_PROG_PIN_CHANGED: number

16

RF_PROG_RFID_ADDED: number

32

RF_PROG_RFID_DELETED: number

64

is_rf_prog_unknown_or_ms_set()
Returns:

True if the value of RF_PROG_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_rf_prog_unknown_or_ms()

Set the value of the bit in the RF_PROG_UNKNOWN_OR_MS field to 1

unset_rf_prog_unknown_or_ms()

Set the value of the bits in the RF_PROG_UNKNOWN_OR_MS field to 0

is_rf_prog_pin_added_set()
Returns:

True if the value of RF_PROG_PIN_ADDED is non-zero

Return type:

boolean

set_rf_prog_pin_added()

Set the value of the bit in the RF_PROG_PIN_ADDED field to 1

unset_rf_prog_pin_added()

Set the value of the bits in the RF_PROG_PIN_ADDED field to 0

is_rf_prog_pin_deleted_set()
Returns:

True if the value of RF_PROG_PIN_DELETED is non-zero

Return type:

boolean

set_rf_prog_pin_deleted()

Set the value of the bit in the RF_PROG_PIN_DELETED field to 1

unset_rf_prog_pin_deleted()

Set the value of the bits in the RF_PROG_PIN_DELETED field to 0

is_rf_prog_pin_changed_set()
Returns:

True if the value of RF_PROG_PIN_CHANGED is non-zero

Return type:

boolean

set_rf_prog_pin_changed()

Set the value of the bit in the RF_PROG_PIN_CHANGED field to 1

unset_rf_prog_pin_changed()

Set the value of the bits in the RF_PROG_PIN_CHANGED field to 0

is_rf_prog_rfid_added_set()
Returns:

True if the value of RF_PROG_RFID_ADDED is non-zero

Return type:

boolean

set_rf_prog_rfid_added()

Set the value of the bit in the RF_PROG_RFID_ADDED field to 1

unset_rf_prog_rfid_added()

Set the value of the bits in the RF_PROG_RFID_ADDED field to 0

is_rf_prog_rfid_deleted_set()
Returns:

True if the value of RF_PROG_RFID_DELETED is non-zero

Return type:

boolean

set_rf_prog_rfid_deleted()

Set the value of the bit in the RF_PROG_RFID_DELETED field to 1

unset_rf_prog_rfid_deleted()

Set the value of the bits in the RF_PROG_RFID_DELETED field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the RFProgrammingEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.DoorLock.RFIDProgrammingEventMask
ID: number

0x0047 the ID of this attribute

NAME: str

“RFIDProgrammingEventMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

RFID_PROG_UNKNOWN_OR_MS: number

1

RFID_PROG_RFID_ADDED: number

32

RFID_PROG_RFID_DELETED: number

64

is_rfid_prog_unknown_or_ms_set()
Returns:

True if the value of RFID_PROG_UNKNOWN_OR_MS is non-zero

Return type:

boolean

set_rfid_prog_unknown_or_ms()

Set the value of the bit in the RFID_PROG_UNKNOWN_OR_MS field to 1

unset_rfid_prog_unknown_or_ms()

Set the value of the bits in the RFID_PROG_UNKNOWN_OR_MS field to 0

is_rfid_prog_rfid_added_set()
Returns:

True if the value of RFID_PROG_RFID_ADDED is non-zero

Return type:

boolean

set_rfid_prog_rfid_added()

Set the value of the bit in the RFID_PROG_RFID_ADDED field to 1

unset_rfid_prog_rfid_added()

Set the value of the bits in the RFID_PROG_RFID_ADDED field to 0

is_rfid_prog_rfid_deleted_set()
Returns:

True if the value of RFID_PROG_RFID_DELETED is non-zero

Return type:

boolean

set_rfid_prog_rfid_deleted()

Set the value of the bit in the RFID_PROG_RFID_DELETED field to 1

unset_rfid_prog_rfid_deleted()

Set the value of the bits in the RFID_PROG_RFID_DELETED field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

base_type_obj (st.zigbee.data_types.Bitmap16) – the base data type object to add functionality to

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the RFIDProgrammingEventMask(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Bitmap16

Return type:

st.zigbee.data_types.Bitmap16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:

DoorLock Commands

class st.zigbee.zcl.clusters.DoorLock.LockDoorResponse
ID: number

0x00 the ID of this command

NAME: str

“LockDoorResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

LockDoorResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:

  • device (st.zigbee.Device) – the device to build the message from

  • status (st.zigbee.data_types.ZclStatus)

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the LockDoorResponse command

Parameters:

  • self (LockDoorResponse) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

  • status (st.zigbee.data_types.ZclStatus)

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.UnlockDoorResponse
ID: number

0x01 the ID of this command

NAME: str

“UnlockDoorResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

UnlockDoorResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:

  • device (st.zigbee.Device) – the device to build the message from

  • status (st.zigbee.data_types.ZclStatus)

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the UnlockDoorResponse command

Parameters:

  • self (UnlockDoorResponse) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

  • status (st.zigbee.data_types.ZclStatus)

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ToggleResponse
ID: number

0x02 the ID of this command

NAME: str

“ToggleResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ToggleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:

  • device (st.zigbee.Device) – the device to build the message from

  • status (st.zigbee.data_types.ZclStatus)

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ToggleResponse command

Parameters:

  • self (ToggleResponse) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

  • status (st.zigbee.data_types.ZclStatus)

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.UnlockWithTimeoutResponse
ID: number

0x03 the ID of this command

NAME: str

“UnlockWithTimeoutResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

UnlockWithTimeoutResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:

  • device (st.zigbee.Device) – the device to build the message from

  • status (st.zigbee.data_types.ZclStatus)

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the UnlockWithTimeoutResponse command

Parameters:

  • self (UnlockWithTimeoutResponse) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

  • status (st.zigbee.data_types.ZclStatus)

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetLogRecordResponse
ID: number

0x04 the ID of this command

NAME: str

“GetLogRecordResponse” the name of this command

log_entry_id: st.zigbee.data_types.Uint16
timestamp: st.zigbee.data_types.Uint32
event_type: st.zigbee.zcl.clusters.DoorLock.types.EventType
source_operation_event: st.zigbee.zcl.clusters.DoorLock.types.DrlkOperationEventSource
event_id_or_alarm_code: st.zigbee.data_types.Uint8
user_id: st.zigbee.data_types.Uint16
pin: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetLogRecordResponse

set_field_names()
static build_test_rx(device, log_entry_id, timestamp, event_type, source_operation_event, event_id_or_alarm_code, user_id, pin)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, log_entry_id, timestamp, event_type, source_operation_event, event_id_or_alarm_code, user_id, pin)

Initialize the GetLogRecordResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetPINCodeResponse
ID: number

0x05 the ID of this command

NAME: str

“SetPINCodeResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkSetCodeStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetPINCodeResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetPINCodeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetPINCodeResponse
ID: number

0x06 the ID of this command

NAME: str

“GetPINCodeResponse” the name of this command

user_id: st.zigbee.data_types.Uint16
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserStatus
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetPINCodeResponse

set_field_names()
static build_test_rx(device, user_id, user_status, user_type, code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_status, user_type, code)

Initialize the GetPINCodeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearPINCodeResponse
ID: number

0x07 the ID of this command

NAME: str

“ClearPINCodeResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearPINCodeResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearPINCodeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearAllPINCodesResponse
ID: number

0x08 the ID of this command

NAME: str

“ClearAllPINCodesResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearAllPINCodesResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearAllPINCodesResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetUserStatusResponse
ID: number

0x09 the ID of this command

NAME: str

“SetUserStatusResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetUserStatusResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetUserStatusResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetUserStatusResponse
ID: number

0x0A the ID of this command

NAME: str

“GetUserStatusResponse” the name of this command

user_id: st.zigbee.data_types.Uint16
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetUserStatusResponse

set_field_names()
static build_test_rx(device, user_id, user_status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_status)

Initialize the GetUserStatusResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetWeekdayScheduleResponse
ID: number

0x0B the ID of this command

NAME: str

“SetWeekdayScheduleResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetWeekdayScheduleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetWeekdayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetWeekdayScheduleResponse
ID: number

0x0C the ID of this command

NAME: str

“GetWeekdayScheduleResponse” the name of this command

schedule_id: st.zigbee.data_types.Uint8
user_id: st.zigbee.data_types.Uint16
status: st.zigbee.data_types.ZclStatus
days_mask: st.zigbee.zcl.clusters.DoorLock.types.DrlkDaysMask
start_hour: st.zigbee.data_types.Uint8
start_minute: st.zigbee.data_types.Uint8
end_hour: st.zigbee.data_types.Uint8
end_minute: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetWeekdayScheduleResponse

set_field_names()
static build_test_rx(device, schedule_id, user_id, status, days_mask, start_hour, start_minute, end_hour, end_minute)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id, status, days_mask, start_hour, start_minute, end_hour, end_minute)

Initialize the GetWeekdayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearWeekdayScheduleResponse
ID: number

0x0D the ID of this command

NAME: str

“ClearWeekdayScheduleResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearWeekdayScheduleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearWeekdayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetYearDayScheduleResponse
ID: number

0x0E the ID of this command

NAME: str

“SetYearDayScheduleResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetYearDayScheduleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetYearDayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetYearDayScheduleResponse
ID: number

0x0F the ID of this command

NAME: str

“GetYearDayScheduleResponse” the name of this command

schedule_id: st.zigbee.data_types.Uint8
user_id: st.zigbee.data_types.Uint16
status: st.zigbee.data_types.ZclStatus
local_start_time: st.zigbee.data_types.Uint32
local_end_time: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetYearDayScheduleResponse

set_field_names()
static build_test_rx(device, schedule_id, user_id, status, local_start_time, local_end_time)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id, status, local_start_time, local_end_time)

Initialize the GetYearDayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearYearDayScheduleResponse
ID: number

0x10 the ID of this command

NAME: str

“ClearYearDayScheduleResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearYearDayScheduleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearYearDayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetHolidayScheduleResponse
ID: number

0x11 the ID of this command

NAME: str

“SetHolidayScheduleResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetHolidayScheduleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetHolidayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetHolidayScheduleResponse
ID: number

0x12 the ID of this command

NAME: str

“GetHolidayScheduleResponse” the name of this command

holiday_schedule_id: st.zigbee.data_types.Uint8
status: st.zigbee.data_types.ZclStatus
local_start_time: st.zigbee.data_types.Uint32
local_end_time: st.zigbee.data_types.Uint32
operating_mode_during_holiday: st.zigbee.zcl.clusters.DoorLock.types.DrlkOperatingMode
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetHolidayScheduleResponse

set_field_names()
static build_test_rx(device, holiday_schedule_id, status, local_start_time, local_end_time, operating_mode_during_holiday)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, holiday_schedule_id, status, local_start_time, local_end_time, operating_mode_during_holiday)

Initialize the GetHolidayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearHolidayScheduleResponse
ID: number

0x13 the ID of this command

NAME: str

“ClearHolidayScheduleResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearHolidayScheduleResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearHolidayScheduleResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetUserTypeResponse
ID: number

0x14 the ID of this command

NAME: str

“SetUserTypeResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetUserTypeResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetUserTypeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetUserTypeResponse
ID: number

0x15 the ID of this command

NAME: str

“GetUserTypeResponse” the name of this command

user_id: st.zigbee.data_types.Uint16
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetUserTypeResponse

set_field_names()
static build_test_rx(device, user_id, user_type)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_type)

Initialize the GetUserTypeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetRFIDCodeResponse
ID: number

0x16 the ID of this command

NAME: str

“SetRFIDCodeResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkSetCodeStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetRFIDCodeResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SetRFIDCodeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetRFIDCodeResponse
ID: number

0x17 the ID of this command

NAME: str

“GetRFIDCodeResponse” the name of this command

user_id: st.zigbee.data_types.Uint16
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserStatus
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
rfid_code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetRFIDCodeResponse

set_field_names()
static build_test_rx(device, user_id, user_status, user_type, rfid_code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_status, user_type, rfid_code)

Initialize the GetRFIDCodeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearRFIDCodeResponse
ID: number

0x18 the ID of this command

NAME: str

“ClearRFIDCodeResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearRFIDCodeResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearRFIDCodeResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearAllRFIDCodesResponse
ID: number

0x19 the ID of this command

NAME: str

“ClearAllRFIDCodesResponse” the name of this command

status: st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearAllRFIDCodesResponse

set_field_names()
static build_test_rx(device, status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ClearAllRFIDCodesResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.OperatingEventNotification
ID: number

0x20 the ID of this command

NAME: str

“OperatingEventNotification” the name of this command

operation_event_source: st.zigbee.zcl.clusters.DoorLock.types.DrlkOperationEventSource
operation_event_code: st.zigbee.zcl.clusters.DoorLock.types.OperationEventCode
user_id: st.zigbee.data_types.Uint16
pin: st.zigbee.data_types.OctetString
local_time: st.zigbee.data_types.Uint32
data: st.zigbee.data_types.CharString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

OperatingEventNotification

set_field_names()
static build_test_rx(device, operation_event_source, operation_event_code, user_id, pin, local_time, data)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, operation_event_source, operation_event_code, user_id, pin, local_time, data)

Initialize the OperatingEventNotification command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ProgrammingEventNotification
ID: number

0x21 the ID of this command

NAME: str

“ProgrammingEventNotification” the name of this command

program_event_source: st.zigbee.zcl.clusters.DoorLock.types.ProgramEventSource
program_event_code: st.zigbee.zcl.clusters.DoorLock.types.ProgramEventCode
user_id: st.zigbee.data_types.Uint16
pin: st.zigbee.data_types.OctetString
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserStatus
local_time: st.zigbee.data_types.Uint32
data: st.zigbee.data_types.CharString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ProgrammingEventNotification

set_field_names()
static build_test_rx(device, program_event_source, program_event_code, user_id, pin, user_type, user_status, local_time, data)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, program_event_source, program_event_code, user_id, pin, user_type, user_status, local_time, data)

Initialize the ProgrammingEventNotification command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.LockDoor
ID: number

0x00 the ID of this command

NAME: str

“LockDoor” the name of this command

pin_or_rfid_code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

LockDoor

set_field_names()
static build_test_rx(device, pin_or_rfid_code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, pin_or_rfid_code)

Initialize the LockDoor command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.UnlockDoor
ID: number

0x01 the ID of this command

NAME: str

“UnlockDoor” the name of this command

pin_or_rfid_code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

UnlockDoor

set_field_names()
static build_test_rx(device, pin_or_rfid_code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, pin_or_rfid_code)

Initialize the UnlockDoor command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.Toggle
ID: number

0x02 the ID of this command

NAME: str

“Toggle” the name of this command

pin_or_rfid_code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

Toggle

set_field_names()
static build_test_rx(device, pin_or_rfid_code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, pin_or_rfid_code)

Initialize the Toggle command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.UnlockWithTimeout
ID: number

0x03 the ID of this command

NAME: str

“UnlockWithTimeout” the name of this command

timeout_in_seconds: st.zigbee.data_types.Uint16
pin_or_rfid_code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

UnlockWithTimeout

set_field_names()
static build_test_rx(device, timeout_in_seconds, pin_or_rfid_code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, timeout_in_seconds, pin_or_rfid_code)

Initialize the UnlockWithTimeout command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetLogRecord
ID: number

0x04 the ID of this command

NAME: str

“GetLogRecord” the name of this command

log_index: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetLogRecord

set_field_names()
static build_test_rx(device, log_index)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, log_index)

Initialize the GetLogRecord command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetPINCode
ID: number

0x05 the ID of this command

NAME: str

“SetPINCode” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkPinUserId
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkSettableUserStatus
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
pin: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetPINCode

set_field_names()
static build_test_rx(device, user_id, user_status, user_type, pin)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_status, user_type, pin)

Initialize the SetPINCode command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetPINCode
ID: number

0x06 the ID of this command

NAME: str

“GetPINCode” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkPinUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetPINCode

set_field_names()
static build_test_rx(device, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id)

Initialize the GetPINCode command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearPINCode
ID: number

0x07 the ID of this command

NAME: str

“ClearPINCode” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkPinUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearPINCode

set_field_names()
static build_test_rx(device, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id)

Initialize the ClearPINCode command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearAllPINCodes
ID: number

0x08 the ID of this command

NAME: str

“ClearAllPINCodes” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearAllPINCodes

set_field_names()
static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters:

device (st.zigbee.Device) – the device to build the message from

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the ClearAllPINCodes command

Parameters:

  • self (ClearAllPINCodes) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetUserStatus
ID: number

0x09 the ID of this command

NAME: str

“SetUserStatus” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkSettableUserStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetUserStatus

set_field_names()
static build_test_rx(device, user_id, user_status)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_status)

Initialize the SetUserStatus command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetUserStatus
ID: number

0x0A the ID of this command

NAME: str

“GetUserStatus” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetUserStatus

set_field_names()
static build_test_rx(device, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id)

Initialize the GetUserStatus command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetWeekdaySchedule
ID: number

0x0B the ID of this command

NAME: str

“SetWeekdaySchedule” the name of this command

schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkWeekDayScheduleId
user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
days_mask: st.zigbee.zcl.clusters.DoorLock.types.DrlkDaysMask
start_hour: st.zigbee.data_types.Uint8
start_minute: st.zigbee.data_types.Uint8
end_hour: st.zigbee.data_types.Uint8
end_minute: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetWeekdaySchedule

set_field_names()
static build_test_rx(device, schedule_id, user_id, days_mask, start_hour, start_minute, end_hour, end_minute)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id, days_mask, start_hour, start_minute, end_hour, end_minute)

Initialize the SetWeekdaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetWeekdaySchedule
ID: number

0x0C the ID of this command

NAME: str

“GetWeekdaySchedule” the name of this command

schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkWeekDayScheduleId
user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetWeekdaySchedule

set_field_names()
static build_test_rx(device, schedule_id, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id)

Initialize the GetWeekdaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearWeekdaySchedule
ID: number

0x0D the ID of this command

NAME: str

“ClearWeekdaySchedule” the name of this command

schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkWeekDayScheduleId
user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearWeekdaySchedule

set_field_names()
static build_test_rx(device, schedule_id, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id)

Initialize the ClearWeekdaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetYearDaySchedule
ID: number

0x0E the ID of this command

NAME: str

“SetYearDaySchedule” the name of this command

schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkYearDayScheduleId
user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
local_start_time: st.zigbee.data_types.Uint32
local_end_time: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetYearDaySchedule

set_field_names()
static build_test_rx(device, schedule_id, user_id, local_start_time, local_end_time)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id, local_start_time, local_end_time)

Initialize the SetYearDaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetYearDaySchedule
ID: number

0x0F the ID of this command

NAME: str

“GetYearDaySchedule” the name of this command

schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkYearDayScheduleId
user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetYearDaySchedule

set_field_names()
static build_test_rx(device, schedule_id, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id)

Initialize the GetYearDaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearYearDaySchedule
ID: number

0x10 the ID of this command

NAME: str

“ClearYearDaySchedule” the name of this command

schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkYearDayScheduleId
user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearYearDaySchedule

set_field_names()
static build_test_rx(device, schedule_id, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, schedule_id, user_id)

Initialize the ClearYearDaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetHolidaySchedule
ID: number

0x11 the ID of this command

NAME: str

“SetHolidaySchedule” the name of this command

holiday_schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkHolidayScheduleId
local_start_time: st.zigbee.data_types.Uint32
local_end_time: st.zigbee.data_types.Uint32
operating_mode_during_holiday: st.zigbee.zcl.clusters.DoorLock.types.DrlkOperatingMode
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetHolidaySchedule

set_field_names()
static build_test_rx(device, holiday_schedule_id, local_start_time, local_end_time, operating_mode_during_holiday)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, holiday_schedule_id, local_start_time, local_end_time, operating_mode_during_holiday)

Initialize the SetHolidaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetHolidaySchedule
ID: number

0x12 the ID of this command

NAME: str

“GetHolidaySchedule” the name of this command

holiday_schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkHolidayScheduleId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetHolidaySchedule

set_field_names()
static build_test_rx(device, holiday_schedule_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, holiday_schedule_id)

Initialize the GetHolidaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearHolidaySchedule
ID: number

0x13 the ID of this command

NAME: str

“ClearHolidaySchedule” the name of this command

holiday_schedule_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkHolidayScheduleId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearHolidaySchedule

set_field_names()
static build_test_rx(device, holiday_schedule_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, holiday_schedule_id)

Initialize the ClearHolidaySchedule command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetUserType
ID: number

0x14 the ID of this command

NAME: str

“SetUserType” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetUserType

set_field_names()
static build_test_rx(device, user_id, user_type)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_type)

Initialize the SetUserType command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetUserType
ID: number

0x15 the ID of this command

NAME: str

“GetUserType” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetUserType

set_field_names()
static build_test_rx(device, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id)

Initialize the GetUserType command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.SetRFIDCode
ID: number

0x16 the ID of this command

NAME: str

“SetRFIDCode” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkRfidUserId
user_status: st.zigbee.zcl.clusters.DoorLock.types.DrlkSettableUserStatus
user_type: st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType
rfid_code: st.zigbee.data_types.OctetString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

SetRFIDCode

set_field_names()
static build_test_rx(device, user_id, user_status, user_type, rfid_code)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id, user_status, user_type, rfid_code)

Initialize the SetRFIDCode command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.GetRFIDCode
ID: number

0x17 the ID of this command

NAME: str

“GetRFIDCode” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkRfidUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetRFIDCode

set_field_names()
static build_test_rx(device, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id)

Initialize the GetRFIDCode command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearRFIDCode
ID: number

0x18 the ID of this command

NAME: str

“ClearRFIDCode” the name of this command

user_id: st.zigbee.zcl.clusters.DoorLock.types.DrlkRfidUserId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearRFIDCode

set_field_names()
static build_test_rx(device, user_id)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, user_id)

Initialize the ClearRFIDCode command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.DoorLock.ClearAllRFIDCodes
ID: number

0x19 the ID of this command

NAME: str

“ClearAllRFIDCodes” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ClearAllRFIDCodes

set_field_names()
static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters:

device (st.zigbee.Device) – the device to build the message from

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the ClearAllRFIDCodes command

Parameters:

  • self (ClearAllRFIDCodes) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

DoorLock Types

class st.zigbee.zcl.clusters.DoorLock.types.DrlkUserStatus: st.zigbee.data_types.Uint8
byte_length: number

1

AVAILABLE: number

0

OCCUPIED_ENABLED: number

1

OCCUPIED_DISABLED: number

3

NOT_SUPPORTED: number

255

class st.zigbee.zcl.clusters.DoorLock.types.DrlkSettableUserStatus: st.zigbee.data_types.Uint8
byte_length: number

1

OCCUPIED_ENABLED: number

1

OCCUPIED_DISABLED: number

3

class st.zigbee.zcl.clusters.DoorLock.types.DrlkUserType: st.zigbee.data_types.Enum8
byte_length: number

1

UNRESTRICTED_USER: number

0

YEAR_DAY_SCHEDULE_USER: number

1

WEEK_DAY_SCHEDULE_USER: number

2

MASTER_USER: number

3

NON_ACCESS_USER: number

4

NOT_SUPPORTED: number

255

class st.zigbee.zcl.clusters.DoorLock.types.DrlkOperatingMode: st.zigbee.data_types.Enum8
byte_length: number

1

NORMAL: number

0

VACATION: number

1

PRIVACY: number

2

NO_RF_LOCK_OR_UNLOCK: number

3

PASSAGE: number

4

class st.zigbee.zcl.clusters.DoorLock.types.DrlkDaysMask: st.zigbee.data_types.Bitmap8
byte_length: number

1

SUN: number

1

MON: number

2

TUE: number

4

WED: number

8

THU: number

16

FRI: number

32

SAT: number

64

ENABLE: number

128

is_sun_set()
Returns:

True if the value of SUN is non-zero

Return type:

boolean

set_sun()

Set the value of the bit in the SUN field to 1

unset_sun()

Set the value of the bits in the SUN field to 0

is_mon_set()
Returns:

True if the value of MON is non-zero

Return type:

boolean

set_mon()

Set the value of the bit in the MON field to 1

unset_mon()

Set the value of the bits in the MON field to 0

is_tue_set()
Returns:

True if the value of TUE is non-zero

Return type:

boolean

set_tue()

Set the value of the bit in the TUE field to 1

unset_tue()

Set the value of the bits in the TUE field to 0

is_wed_set()
Returns:

True if the value of WED is non-zero

Return type:

boolean

set_wed()

Set the value of the bit in the WED field to 1

unset_wed()

Set the value of the bits in the WED field to 0

is_thu_set()
Returns:

True if the value of THU is non-zero

Return type:

boolean

set_thu()

Set the value of the bit in the THU field to 1

unset_thu()

Set the value of the bits in the THU field to 0

is_fri_set()
Returns:

True if the value of FRI is non-zero

Return type:

boolean

set_fri()

Set the value of the bit in the FRI field to 1

unset_fri()

Set the value of the bits in the FRI field to 0

is_sat_set()
Returns:

True if the value of SAT is non-zero

Return type:

boolean

set_sat()

Set the value of the bit in the SAT field to 1

unset_sat()

Set the value of the bits in the SAT field to 0

is_enable_set()
Returns:

True if the value of ENABLE is non-zero

Return type:

boolean

set_enable()

Set the value of the bit in the ENABLE field to 1

unset_enable()

Set the value of the bits in the ENABLE field to 0

class st.zigbee.zcl.clusters.DoorLock.types.DrlkPassFailStatus: st.zigbee.data_types.Uint8
byte_length: number

1

PASS: number

0

FAIL: number

1

class st.zigbee.zcl.clusters.DoorLock.types.DrlkSetCodeStatus: st.zigbee.data_types.Uint8
byte_length: number

1

SUCCESS: number

0

GENERAL_FAILURE: number

1

MEMORY_FULL: number

2

DUPLICATE_CODE: number

3

class st.zigbee.zcl.clusters.DoorLock.types.DrlkOperationEventSource: st.zigbee.data_types.Uint8
byte_length: number

1

KEYPAD: number

0

RF: number

1

MANUAL: number

2

RFID: number

3

INDETERMINATE: number

255

class st.zigbee.zcl.clusters.DoorLock.types.DrlkPinUserId: st.zigbee.data_types.Uint16
class st.zigbee.zcl.clusters.DoorLock.types.DrlkRfidUserId: st.zigbee.data_types.Uint16
class st.zigbee.zcl.clusters.DoorLock.types.DrlkTotalUserId: st.zigbee.data_types.Uint16
class st.zigbee.zcl.clusters.DoorLock.types.DrlkWeekDayScheduleId: st.zigbee.data_types.Uint8
class st.zigbee.zcl.clusters.DoorLock.types.DrlkYearDayScheduleId: st.zigbee.data_types.Uint8
class st.zigbee.zcl.clusters.DoorLock.types.DrlkHolidayScheduleId: st.zigbee.data_types.Uint8
class st.zigbee.zcl.clusters.DoorLock.types.EventType: st.zigbee.data_types.Enum8
byte_length: number

1

OPERATION: number

0

PROGRAMMING: number

1

ALARM: number

2

class st.zigbee.zcl.clusters.DoorLock.types.OperationEventCode: st.zigbee.data_types.Uint8
byte_length: number

1

UNKNOWN_OR_MS: number

0

LOCK: number

1

UNLOCK: number

2

LOCK_FAILURE_INVALID_PIN_OR_ID: number

3

LOCK_FAILURE_INVALID_SCHEDULE: number

4

UNLOCK_FAILURE_INVALID_PIN_OR_ID: number

5

UNLOCK_FAILURE_INVALID_SCHEDULE: number

6

ONE_TOUCH_LOCK: number

7

KEY_LOCK: number

8

KEY_UNLOCK: number

9

AUTO_LOCK: number

10

SCHEDULE_LOCK: number

11

SCHEDULE_UNLOCK: number

12

MANUAL_LOCK: number

13

MANUAL_UNLOCK: number

14

NON_ACCESS_USER_OPERATIONAL_EVENT: number

15

class st.zigbee.zcl.clusters.DoorLock.types.ProgramEventSource: st.zigbee.data_types.Uint8
byte_length: number

1

KEYPAD: number

0

RF: number

1

RFID: number

3

INDETERMINATE: number

255

class st.zigbee.zcl.clusters.DoorLock.types.ProgramEventCode: st.zigbee.data_types.Uint8
byte_length: number

1

UNKNOWN_OR_MS: number

0

MASTER_CODE_CHANGED: number

1

PIN_CODE_ADDED: number

2

PIN_CODE_DELETED: number

3

PIN_CODE_CHANGED: number

4

RFID_CODE_ADDED: number

5

RFID_CODE_DELETED: number

6