DoorLock 

subscribe(device, endpoint_id)

Reporting policy: LockState => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an LockState test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.LockType

ID: number: 0x0001 the ID of this attribute

NAME: str: “LockType” the name of this attribute

data_type: st.matter.data_types.Uint32: 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.matter.data_types.Uint32) – the base data type object to add functionality to

new_value(...)

Create a Uint32 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 Uint32
Return type: st.matter.data_types.Uint32

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: LockType => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an LockType test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ActuatorEnabled

ID: number: 0x0002 the ID of this attribute

NAME: str: “ActuatorEnabled” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

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.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: ActuatorEnabled => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an ActuatorEnabled test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.DoorState

ID: number: 0x0003 the ID of this attribute

NAME: str: “DoorState” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

DOOR_OPEN: number: 0

DOOR_CLOSED: number: 1

DOOR_JAMMED: number: 2

DOOR_FORCED_OPEN: number: 3

DOOR_UNSPECIFIED_ERROR: number: 4

DOOR_AJAR: number: 5

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Uint32) – the base data type object to add functionality to

new_value(...)

Create a Uint32 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 Uint32
Return type: st.matter.data_types.Uint32

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: DoorState => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an DoorState test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.DoorOpenEvents

ID: number: 0x0004 the ID of this attribute

NAME: str: “DoorOpenEvents” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

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.matter.data_types.Uint32

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint32) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: DoorOpenEvents => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an DoorOpenEvents test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.DoorClosedEvents

ID: number: 0x0005 the ID of this attribute

NAME: str: “DoorClosedEvents” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

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.matter.data_types.Uint32

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint32) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: DoorClosedEvents => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an DoorClosedEvents test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.OpenPeriod

ID: number: 0x0006 the ID of this attribute

NAME: str: “OpenPeriod” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

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.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.data_types.Uint16

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint16) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: OpenPeriod => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an OpenPeriod test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfTotalUsersSupported

ID: number: 0x0011 the ID of this attribute

NAME: str: “NumberOfTotalUsersSupported” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

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.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfTotalUsersSupported => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfTotalUsersSupported test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfPINUsersSupported

ID: number: 0x0012 the ID of this attribute

NAME: str: “NumberOfPINUsersSupported” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

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.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfPINUsersSupported => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfPINUsersSupported test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfRFIDUsersSupported

ID: number: 0x0013 the ID of this attribute

NAME: str: “NumberOfRFIDUsersSupported” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

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.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfRFIDUsersSupported => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfRFIDUsersSupported test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfWeekDaySchedulesSupportedPerUser

ID: number: 0x0014 the ID of this attribute

NAME: str: “NumberOfWeekDaySchedulesSupportedPerUser” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfWeekDaySchedulesSupportedPerUser => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfWeekDaySchedulesSupportedPerUser test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfYearDaySchedulesSupportedPerUser

ID: number: 0x0015 the ID of this attribute

NAME: str: “NumberOfYearDaySchedulesSupportedPerUser” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfYearDaySchedulesSupportedPerUser => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfYearDaySchedulesSupportedPerUser test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfHolidaySchedulesSupported

ID: number: 0x0016 the ID of this attribute

NAME: str: “NumberOfHolidaySchedulesSupported” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfHolidaySchedulesSupported => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfHolidaySchedulesSupported test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.MaxPINCodeLength

ID: number: 0x0017 the ID of this attribute

NAME: str: “MaxPINCodeLength” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: MaxPINCodeLength => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an MaxPINCodeLength test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.MinPINCodeLength

ID: number: 0x0018 the ID of this attribute

NAME: str: “MinPINCodeLength” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: MinPINCodeLength => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an MinPINCodeLength test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.MaxRFIDCodeLength

ID: number: 0x0019 the ID of this attribute

NAME: str: “MaxRFIDCodeLength” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: MaxRFIDCodeLength => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an MaxRFIDCodeLength test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.MinRFIDCodeLength

ID: number: 0x001A the ID of this attribute

NAME: str: “MinRFIDCodeLength” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: MinRFIDCodeLength => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an MinRFIDCodeLength test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.CredentialRulesSupport

ID: number: 0x001B the ID of this attribute

NAME: str: “CredentialRulesSupport” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

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

new_value(...)

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

This is also usable with the CredentialRulesSupport(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: CredentialRulesSupport => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an CredentialRulesSupport test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.NumberOfCredentialsSupportedPerUser

ID: number: 0x001C the ID of this attribute

NAME: str: “NumberOfCredentialsSupportedPerUser” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

new_value(...)

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

This is also usable with the NumberOfCredentialsSupportedPerUser(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: NumberOfCredentialsSupportedPerUser => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an NumberOfCredentialsSupportedPerUser test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.Language

ID: number: 0x0021 the ID of this attribute

NAME: str: “Language” the name of this attribute

data_type: st.matter.data_types.UTF8String1: the data type of this attribute

new_value(...)

Create a UTF8String1 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 UTF8String1
Return type: st.matter.data_types.UTF8String1

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.data_types.UTF8String1

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.UTF8String1) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: Language => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an Language test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.LEDSettings

ID: number: 0x0022 the ID of this attribute

NAME: str: “LEDSettings” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint8) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: LEDSettings => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an LEDSettings test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.AutoRelockTime

ID: number: 0x0023 the ID of this attribute

NAME: str: “AutoRelockTime” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

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.matter.data_types.Uint32

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint32) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: AutoRelockTime => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AutoRelockTime test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SoundVolume

ID: number: 0x0024 the ID of this attribute

NAME: str: “SoundVolume” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint8) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: SoundVolume => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SoundVolume test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.OperatingMode

ID: number: 0x0025 the ID of this attribute

NAME: str: “OperatingMode” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

NORMAL: number: 0

VACATION: number: 1

PRIVACY: number: 2

NO_REMOTE_LOCK_UNLOCK: number: 3

PASSAGE: number: 4

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Uint32) – the base data type object to add functionality to

new_value(...)

Create a Uint32 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 Uint32
Return type: st.matter.data_types.Uint32

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint32) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: OperatingMode => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an OperatingMode test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SupportedOperatingModes

ID: number: 0x0026 the ID of this attribute

NAME: str: “SupportedOperatingModes” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Uint16) – the base data type object to add functionality to

new_value(...)

Create a Uint16 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 Uint16
Return type: st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: SupportedOperatingModes => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SupportedOperatingModes test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.DefaultConfigurationRegister

ID: number: 0x0027 the ID of this attribute

NAME: str: “DefaultConfigurationRegister” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Uint16) – the base data type object to add functionality to

new_value(...)

Create a Uint16 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 Uint16
Return type: st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: DefaultConfigurationRegister => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an DefaultConfigurationRegister test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.EnableLocalProgramming

ID: number: 0x0028 the ID of this attribute

NAME: str: “EnableLocalProgramming” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

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.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Boolean) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: EnableLocalProgramming => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EnableLocalProgramming test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.EnableOneTouchLocking

ID: number: 0x0029 the ID of this attribute

NAME: str: “EnableOneTouchLocking” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

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.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Boolean) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: EnableOneTouchLocking => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EnableOneTouchLocking test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.EnableInsideStatusLED

ID: number: 0x002A the ID of this attribute

NAME: str: “EnableInsideStatusLED” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

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.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Boolean) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: EnableInsideStatusLED => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EnableInsideStatusLED test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.EnablePrivacyModeButton

ID: number: 0x002B the ID of this attribute

NAME: str: “EnablePrivacyModeButton” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

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.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Boolean) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: EnablePrivacyModeButton => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EnablePrivacyModeButton test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.LocalProgrammingFeatures

ID: number: 0x002C the ID of this attribute

NAME: str: “LocalProgrammingFeatures” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

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

new_value(...)

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

This is also usable with the LocalProgrammingFeatures(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint8) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: LocalProgrammingFeatures => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an LocalProgrammingFeatures test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.WrongCodeEntryLimit

ID: number: 0x0030 the ID of this attribute

NAME: str: “WrongCodeEntryLimit” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint8) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: WrongCodeEntryLimit => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an WrongCodeEntryLimit test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.UserCodeTemporaryDisableTime

ID: number: 0x0031 the ID of this attribute

NAME: str: “UserCodeTemporaryDisableTime” the name of this attribute

data_type: st.matter.data_types.Uint8: the data type of this attribute

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.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint8) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: UserCodeTemporaryDisableTime => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an UserCodeTemporaryDisableTime test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SendPINOverTheAir

ID: number: 0x0032 the ID of this attribute

NAME: str: “SendPINOverTheAir” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

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.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Boolean) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: SendPINOverTheAir => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SendPINOverTheAir test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.RequirePINforRemoteOperation

ID: number: 0x0033 the ID of this attribute

NAME: str: “RequirePINforRemoteOperation” the name of this attribute

data_type: st.matter.data_types.Boolean: the data type of this attribute

new_value(...)

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

This is also usable with the RequirePINforRemoteOperation(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Boolean
Return type: st.matter.data_types.Boolean

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Boolean) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: RequirePINforRemoteOperation => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an RequirePINforRemoteOperation test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ExpiringUserTimeout

ID: number: 0x0035 the ID of this attribute

NAME: str: “ExpiringUserTimeout” the name of this attribute

data_type: st.matter.data_types.Uint16: the data type of this attribute

new_value(...)

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

This is also usable with the ExpiringUserTimeout(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint16
Return type: st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.data_types.Uint16

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –
value (st.matter.data_types.Uint16) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: ExpiringUserTimeout => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an ExpiringUserTimeout test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.AcceptedCommandList

ID: number: 0xFFF9 the ID of this attribute

NAME: str: “AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

new_value(...)

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

This is also usable with the AcceptedCommandList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.AttributeList

ID: number: 0xFFFB the ID of this attribute

NAME: str: “AttributeList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

new_value(...)

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

This is also usable with the AttributeList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Client Commands

class st.matter.clusters.DoorLock.GetWeekDayScheduleResponse

ID: number: 0x000C the ID of this command

NAME: str: “GetWeekDayScheduleResponse” the name of this command

week_day_index: data_types.Uint8

user_index: data_types.Uint16

status: st.matter.clusters.DoorLock.types.DlStatus

days_mask: st.matter.clusters.DoorLock.types.DlDaysMaskMap

start_hour: data_types.Uint8

start_minute: data_types.Uint8

end_hour: data_types.Uint8

end_minute: data_types.Uint8

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, week_day_index, user_index, status, days_mask, start_hour, start_minute, end_hour, end_minute)

Builds an GetWeekDayScheduleResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
week_day_index (data_types.Uint8) –
user_index (data_types.Uint16) –
status (st.matter.clusters.DoorLock.types.DlStatus) –
days_mask (st.matter.clusters.DoorLock.types.DlDaysMaskMap) –
start_hour (data_types.Uint8) –
start_minute (data_types.Uint8) –
end_hour (data_types.Uint8) –
end_minute (data_types.Uint8) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the GetWeekDayScheduleResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetYearDayScheduleResponse

ID: number: 0x000F the ID of this command

NAME: str: “GetYearDayScheduleResponse” the name of this command

year_day_index: data_types.Uint8

user_index: data_types.Uint16

status: st.matter.clusters.DoorLock.types.DlStatus

local_start_time: data_types.Uint32

local_end_time: data_types.Uint32

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, year_day_index, user_index, status, local_start_time, local_end_time)

Builds an GetYearDayScheduleResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
year_day_index (data_types.Uint8) –
user_index (data_types.Uint16) –
status (st.matter.clusters.DoorLock.types.DlStatus) –
local_start_time (data_types.Uint32) –
local_end_time (data_types.Uint32) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the GetYearDayScheduleResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetHolidayScheduleResponse

ID: number: 0x0012 the ID of this command

NAME: str: “GetHolidayScheduleResponse” the name of this command

holiday_index: data_types.Uint8

status: st.matter.clusters.DoorLock.types.DlStatus

local_start_time: data_types.Uint32

local_end_time: data_types.Uint32

operating_mode: st.matter.clusters.DoorLock.types.DlOperatingMode

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, holiday_index, status, local_start_time, local_end_time, operating_mode)

Builds an GetHolidayScheduleResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
holiday_index (data_types.Uint8) –
status (st.matter.clusters.DoorLock.types.DlStatus) –
local_start_time (data_types.Uint32) –
local_end_time (data_types.Uint32) –
operating_mode (st.matter.clusters.DoorLock.types.DlOperatingMode) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the GetHolidayScheduleResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetUserResponse

ID: number: 0x001C the ID of this command

NAME: str: “GetUserResponse” the name of this command

user_index: data_types.Uint16

user_name: data_types.UTF8String1

user_unique_id: data_types.Uint32

user_status: st.matter.clusters.DoorLock.types.DlUserStatus

user_type: st.matter.clusters.DoorLock.types.DlUserType

credential_rule: st.matter.clusters.DoorLock.types.DlCredentialRule

credentials: st.matter.clusters.DoorLock.types.DlCredential

creator_fabric_index: data_types.Uint8

last_modified_fabric_index: data_types.Uint8

next_user_index: data_types.Uint16

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, user_index, user_name, user_unique_id, user_status, user_type, credential_rule, credentials, creator_fabric_index, last_modified_fabric_index, next_user_index)

Builds an GetUserResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
user_index (data_types.Uint16) –
user_name (data_types.UTF8String1) –
user_unique_id (data_types.Uint32) –
user_status (st.matter.clusters.DoorLock.types.DlUserStatus) –
user_type (st.matter.clusters.DoorLock.types.DlUserType) –
credential_rule (st.matter.clusters.DoorLock.types.DlCredentialRule) –
credentials (st.matter.clusters.DoorLock.types.DlCredential) –
creator_fabric_index (data_types.Uint8) –
last_modified_fabric_index (data_types.Uint8) –
next_user_index (data_types.Uint16) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the GetUserResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SetCredentialResponse

ID: number: 0x0023 the ID of this command

NAME: str: “SetCredentialResponse” the name of this command

status: st.matter.clusters.DoorLock.types.DlStatus

user_index: data_types.Uint16

next_credential_index: data_types.Uint16

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, status, user_index, next_credential_index)

Builds an SetCredentialResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (st.matter.clusters.DoorLock.types.DlStatus) –
user_index (data_types.Uint16) –
next_credential_index (data_types.Uint16) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the SetCredentialResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetCredentialStatusResponse

ID: number: 0x0025 the ID of this command

NAME: str: “GetCredentialStatusResponse” the name of this command

credential_exists: data_types.Boolean

user_index: data_types.Uint16

creator_fabric_index: data_types.Uint8

last_modified_fabric_index: data_types.Uint8

next_credential_index: data_types.Uint16

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, credential_exists, user_index, creator_fabric_index, last_modified_fabric_index, next_credential_index)

Builds an GetCredentialStatusResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
credential_exists (data_types.Boolean) –
user_index (data_types.Uint16) –
creator_fabric_index (data_types.Uint8) –
last_modified_fabric_index (data_types.Uint8) –
next_credential_index (data_types.Uint16) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the GetCredentialStatusResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Server Commands

class st.matter.clusters.DoorLock.LockDoor

ID: number: 0x0000 the ID of this command

NAME: str: “LockDoor” the name of this command

pin_code: data_types.OctetString1

build_test_command_response(device, endpoint_id, status)

Builds an LockDoor test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, pin_code)

Initialize the LockDoor command

Parameters

self (LockDoor) – the template class for this command
device (st.matter.Device) – the device to build this message to
pin_code (st.matter.data_types.OctetString1) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.UnlockDoor

ID: number: 0x0001 the ID of this command

NAME: str: “UnlockDoor” the name of this command

pin_code: data_types.OctetString1

build_test_command_response(device, endpoint_id, status)

Builds an UnlockDoor test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, pin_code)

Initialize the UnlockDoor command

Parameters

self (UnlockDoor) – the template class for this command
device (st.matter.Device) – the device to build this message to
pin_code (st.matter.data_types.OctetString1) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.UnlockWithTimeout

ID: number: 0x0003 the ID of this command

NAME: str: “UnlockWithTimeout” the name of this command

timeout: data_types.Uint16

pin_code: data_types.OctetString1

build_test_command_response(device, endpoint_id, status)

Builds an UnlockWithTimeout test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, timeout, pin_code)

Initialize the UnlockWithTimeout command

Parameters

self (UnlockWithTimeout) – the template class for this command
device (st.matter.Device) – the device to build this message to
timeout (st.matter.data_types.Uint16) –
pin_code (st.matter.data_types.OctetString1) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SetWeekDaySchedule

ID: number: 0x000B the ID of this command

NAME: str: “SetWeekDaySchedule” the name of this command

week_day_index: data_types.Uint8

user_index: data_types.Uint16

days_mask: st.matter.clusters.DoorLock.types.DlDaysMaskMap

start_hour: data_types.Uint8

start_minute: data_types.Uint8

end_hour: data_types.Uint8

end_minute: data_types.Uint8

build_test_command_response(device, endpoint_id, status)

Builds an SetWeekDaySchedule test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, week_day_index, user_index, days_mask, start_hour, start_minute, end_hour, end_minute)

Initialize the SetWeekDaySchedule command

Parameters

self (SetWeekDaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
week_day_index (st.matter.data_types.Uint8) –
user_index (st.matter.data_types.Uint16) –
days_mask (st.matter.clusters.DoorLock.types.DlDaysMaskMap) –
start_hour (st.matter.data_types.Uint8) –
start_minute (st.matter.data_types.Uint8) –
end_hour (st.matter.data_types.Uint8) –
end_minute (st.matter.data_types.Uint8) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetWeekDaySchedule

ID: number: 0x000C the ID of this command

NAME: str: “GetWeekDaySchedule” the name of this command

week_day_index: data_types.Uint8

user_index: data_types.Uint16

init(self, device, week_day_index, user_index)

Refer to GetWeekDayScheduleResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetWeekDaySchedule command

Parameters

self (GetWeekDaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
week_day_index (st.matter.data_types.Uint8) –
user_index (st.matter.data_types.Uint16) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ClearWeekDaySchedule

ID: number: 0x000D the ID of this command

NAME: str: “ClearWeekDaySchedule” the name of this command

week_day_index: data_types.Uint8

user_index: data_types.Uint16

build_test_command_response(device, endpoint_id, status)

Builds an ClearWeekDaySchedule test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, week_day_index, user_index)

Initialize the ClearWeekDaySchedule command

Parameters

self (ClearWeekDaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
week_day_index (st.matter.data_types.Uint8) –
user_index (st.matter.data_types.Uint16) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SetYearDaySchedule

ID: number: 0x000E the ID of this command

NAME: str: “SetYearDaySchedule” the name of this command

year_day_index: data_types.Uint8

user_index: data_types.Uint16

local_start_time: data_types.Uint32

local_end_time: data_types.Uint32

build_test_command_response(device, endpoint_id, status)

Builds an SetYearDaySchedule test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, year_day_index, user_index, local_start_time, local_end_time)

Initialize the SetYearDaySchedule command

Parameters

self (SetYearDaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
year_day_index (st.matter.data_types.Uint8) –
user_index (st.matter.data_types.Uint16) –
local_start_time (st.matter.data_types.Uint32) –
local_end_time (st.matter.data_types.Uint32) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetYearDaySchedule

ID: number: 0x000F the ID of this command

NAME: str: “GetYearDaySchedule” the name of this command

year_day_index: data_types.Uint8

user_index: data_types.Uint16

init(self, device, year_day_index, user_index)

Refer to GetYearDayScheduleResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetYearDaySchedule command

Parameters

self (GetYearDaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
year_day_index (st.matter.data_types.Uint8) –
user_index (st.matter.data_types.Uint16) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ClearYearDaySchedule

ID: number: 0x0010 the ID of this command

NAME: str: “ClearYearDaySchedule” the name of this command

year_day_index: data_types.Uint8

user_index: data_types.Uint16

build_test_command_response(device, endpoint_id, status)

Builds an ClearYearDaySchedule test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, year_day_index, user_index)

Initialize the ClearYearDaySchedule command

Parameters

self (ClearYearDaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
year_day_index (st.matter.data_types.Uint8) –
user_index (st.matter.data_types.Uint16) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SetHolidaySchedule

ID: number: 0x0011 the ID of this command

NAME: str: “SetHolidaySchedule” the name of this command

holiday_index: data_types.Uint8

local_start_time: data_types.Uint32

local_end_time: data_types.Uint32

operating_mode: st.matter.clusters.DoorLock.types.DlOperatingMode

build_test_command_response(device, endpoint_id, status)

Builds an SetHolidaySchedule test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, holiday_index, local_start_time, local_end_time, operating_mode)

Initialize the SetHolidaySchedule command

Parameters

self (SetHolidaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
holiday_index (st.matter.data_types.Uint8) –
local_start_time (st.matter.data_types.Uint32) –
local_end_time (st.matter.data_types.Uint32) –
operating_mode (st.matter.clusters.DoorLock.types.DlOperatingMode) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetHolidaySchedule

ID: number: 0x0012 the ID of this command

NAME: str: “GetHolidaySchedule” the name of this command

holiday_index: data_types.Uint8

init(self, device, holiday_index)

Refer to GetHolidayScheduleResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetHolidaySchedule command

Parameters

self (GetHolidaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
holiday_index (st.matter.data_types.Uint8) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ClearHolidaySchedule

ID: number: 0x0013 the ID of this command

NAME: str: “ClearHolidaySchedule” the name of this command

holiday_index: data_types.Uint8

build_test_command_response(device, endpoint_id, status)

Builds an ClearHolidaySchedule test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, holiday_index)

Initialize the ClearHolidaySchedule command

Parameters

self (ClearHolidaySchedule) – the template class for this command
device (st.matter.Device) – the device to build this message to
holiday_index (st.matter.data_types.Uint8) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SetUser

ID: number: 0x001A the ID of this command

NAME: str: “SetUser” the name of this command

operation_type: st.matter.clusters.DoorLock.types.DlDataOperationType

user_index: data_types.Uint16

user_name: data_types.UTF8String1

user_unique_id: data_types.Uint32

user_status: st.matter.clusters.DoorLock.types.DlUserStatus

user_type: st.matter.clusters.DoorLock.types.DlUserType

credential_rule: st.matter.clusters.DoorLock.types.DlCredentialRule

build_test_command_response(device, endpoint_id, status)

Builds an SetUser test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, operation_type, user_index, user_name, user_unique_id, user_status, user_type, credential_rule)

Initialize the SetUser command

Parameters

self (SetUser) – the template class for this command
device (st.matter.Device) – the device to build this message to
operation_type (st.matter.clusters.DoorLock.types.DlDataOperationType) –
user_index (st.matter.data_types.Uint16) –
user_name (st.matter.data_types.UTF8String1) –
user_unique_id (st.matter.data_types.Uint32) –
user_status (st.matter.clusters.DoorLock.types.DlUserStatus) –
user_type (st.matter.clusters.DoorLock.types.DlUserType) –
credential_rule (st.matter.clusters.DoorLock.types.DlCredentialRule) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetUser

ID: number: 0x001B the ID of this command

NAME: str: “GetUser” the name of this command

user_index: data_types.Uint16

init(self, device, user_index)

Refer to GetUserResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetUser command

Parameters

self (GetUser) – the template class for this command
device (st.matter.Device) – the device to build this message to
user_index (st.matter.data_types.Uint16) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ClearUser

ID: number: 0x001D the ID of this command

NAME: str: “ClearUser” the name of this command

user_index: data_types.Uint16

build_test_command_response(device, endpoint_id, status)

Builds an ClearUser test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, user_index)

Initialize the ClearUser command

Parameters

self (ClearUser) – the template class for this command
device (st.matter.Device) – the device to build this message to
user_index (st.matter.data_types.Uint16) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.SetCredential

ID: number: 0x0022 the ID of this command

NAME: str: “SetCredential” the name of this command

operation_type: st.matter.clusters.DoorLock.types.DlDataOperationType

credential: st.matter.clusters.DoorLock.types.DlCredential

credential_data: data_types.OctetString2

user_index: data_types.Uint16

user_status: st.matter.clusters.DoorLock.types.DlUserStatus

user_type: st.matter.clusters.DoorLock.types.DlUserType

init(self, device, operation_type, credential, credential_data, user_index, user_status, user_type)

Refer to SetCredentialResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the SetCredential command

Parameters

self (SetCredential) – the template class for this command
device (st.matter.Device) – the device to build this message to
operation_type (st.matter.clusters.DoorLock.types.DlDataOperationType) –
credential (st.matter.clusters.DoorLock.types.DlCredential) –
credential_data (st.matter.data_types.OctetString2) –
user_index (st.matter.data_types.Uint16) –
user_status (st.matter.clusters.DoorLock.types.DlUserStatus) –
user_type (st.matter.clusters.DoorLock.types.DlUserType) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.GetCredentialStatus

ID: number: 0x0024 the ID of this command

NAME: str: “GetCredentialStatus” the name of this command

credential: st.matter.clusters.DoorLock.types.DlCredential

init(self, device, credential)

Refer to GetCredentialStatusResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetCredentialStatus command

Parameters

self (GetCredentialStatus) – the template class for this command
device (st.matter.Device) – the device to build this message to
credential (st.matter.clusters.DoorLock.types.DlCredential) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.DoorLock.ClearCredential

ID: number: 0x0026 the ID of this command

NAME: str: “ClearCredential” the name of this command

credential: st.matter.clusters.DoorLock.types.DlCredential

build_test_command_response(device, endpoint_id, status)

Builds an ClearCredential test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, credential)

Initialize the ClearCredential command

Parameters

self (ClearCredential) – the template class for this command
device (st.matter.Device) – the device to build this message to
credential (st.matter.clusters.DoorLock.types.DlCredential) –

Returns

of type INVOKE

Return type

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Events

class st.matter.clusters.DoorLock.DoorLockAlarm

ID: number: 0x0000 the ID of this event

NAME: str: “DoorLockAlarm” the name of this event

alarm_code: st.matter.clusters.DoorLock.types.DlAlarmCode

augment_type(base_type_obj)

Add field names to each event field

Parameters: base_type_obj (st.matter.data_types.Structure) –

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Return type

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

build_test_event_report(device, endpoint_id, fields, status)

Builds an DoorLockAlarm test event report reponse to be used by

the driver integration testing framework.

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
fields (table) – containing the event fields
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.matter.clusters.DoorLock.DoorStateChange

ID: number: 0x0001 the ID of this event

NAME: str: “DoorStateChange” the name of this event

door_state: st.matter.clusters.DoorLock.types.DlDoorState

augment_type(base_type_obj)

Add field names to each event field

Parameters: base_type_obj (st.matter.data_types.Structure) –

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Return type

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

build_test_event_report(device, endpoint_id, fields, status)

Builds an DoorStateChange test event report reponse to be used by

the driver integration testing framework.

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
fields (table) – containing the event fields
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.matter.clusters.DoorLock.LockOperation

ID: number: 0x0002 the ID of this event

NAME: str: “LockOperation” the name of this event

lock_operation_type: st.matter.clusters.DoorLock.types.DlLockOperationType

operation_source: st.matter.clusters.DoorLock.types.DlOperationSource

user_index: data_types.Uint16

fabric_index: data_types.Uint8

source_node: data_types.Uint64

credentials: data_types.Array

augment_type(base_type_obj)

Add field names to each event field

Parameters: base_type_obj (st.matter.data_types.Structure) –

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Return type

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

build_test_event_report(device, endpoint_id, fields, status)

Builds an LockOperation test event report reponse to be used by

the driver integration testing framework.

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
fields (table) – containing the event fields
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.matter.clusters.DoorLock.LockOperationError

ID: number: 0x0003 the ID of this event

NAME: str: “LockOperationError” the name of this event

lock_operation_type: st.matter.clusters.DoorLock.types.DlLockOperationType

operation_source: st.matter.clusters.DoorLock.types.DlOperationSource

operation_error: st.matter.clusters.DoorLock.types.DlOperationError

user_index: data_types.Uint16

fabric_index: data_types.Uint8

source_node: data_types.Uint64

credentials: data_types.Array

augment_type(base_type_obj)

Add field names to each event field

Parameters: base_type_obj (st.matter.data_types.Structure) –

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Return type

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

build_test_event_report(device, endpoint_id, fields, status)

Builds an LockOperationError test event report reponse to be used by

the driver integration testing framework.

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
fields (table) – containing the event fields
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.matter.clusters.DoorLock.LockUserChange

ID: number: 0x0004 the ID of this event

NAME: str: “LockUserChange” the name of this event

lock_data_type: st.matter.clusters.DoorLock.types.DlLockDataType

data_operation_type: st.matter.clusters.DoorLock.types.DlDataOperationType

operation_source: st.matter.clusters.DoorLock.types.DlOperationSource

user_index: data_types.Uint16

fabric_index: data_types.Uint8

source_node: data_types.Uint64

data_index: data_types.Uint16

augment_type(base_type_obj)

Add field names to each event field

Parameters: base_type_obj (st.matter.data_types.Structure) –

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Return type

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

build_test_event_report(device, endpoint_id, fields, status)

Builds an LockUserChange test event report reponse to be used by

the driver integration testing framework.

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
fields (table) – containing the event fields
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type