DoorLock
Attributes
- class st.matter.clusters.DoorLock.LockState
- ID: number
0x0000 the ID of this attribute
- NAME: str
“LockState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.DoorLock.types.DlLockState
the data type of this attribute
- new_value(...)
Create a DlLockState object of this attribute with any additional features provided for the attribute
This is also usable with the LockState(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a DlLockState- Return type
st.matter.generated.zap_clusters.DoorLock.types.DlLockState
- 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: 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 forendpoint_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.generated.zap_clusters.DoorLock.types.DlLockType
the data type of this attribute
- new_value(...)
Create a DlLockType 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 DlLockType- Return type
st.matter.generated.zap_clusters.DoorLock.types.DlLockType
- 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 forendpoint_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
- 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 forendpoint_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.generated.zap_clusters.DoorLock.types.DoorStateEnum
the data type of this attribute
- new_value(...)
Create a DoorStateEnum 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 DoorStateEnum- Return type
st.matter.generated.zap_clusters.DoorLock.types.DoorStateEnum
- 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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.Uint16) – 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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
- 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 forendpoint_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.generated.zap_clusters.DoorLock.types.DlCredentialRuleMask
the data type of this attribute
- new_value(...)
Create a DlCredentialRuleMask 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 DlCredentialRuleMask- Return type
st.matter.generated.zap_clusters.DoorLock.types.DlCredentialRuleMask
- 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 forendpoint_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
- 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 forendpoint_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
- 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.UTF8String1) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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.generated.zap_clusters.DoorLock.types.OperatingModeEnum
the data type of this attribute
- new_value(...)
Create a OperatingModeEnum 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 OperatingModeEnum- Return type
st.matter.generated.zap_clusters.DoorLock.types.OperatingModeEnum
- 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.generated.zap_clusters.DoorLock.types.OperatingModeEnum) – 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 forendpoint_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.generated.zap_clusters.DoorLock.types.DlSupportedOperatingModes
the data type of this attribute
- new_value(...)
Create a DlSupportedOperatingModes 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 DlSupportedOperatingModes- Return type
st.matter.generated.zap_clusters.DoorLock.types.DlSupportedOperatingModes
- 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 forendpoint_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.generated.zap_clusters.DoorLock.types.DlDefaultConfigurationRegister
the data type of this attribute
- new_value(...)
Create a DlDefaultConfigurationRegister 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 DlDefaultConfigurationRegister- Return type
st.matter.generated.zap_clusters.DoorLock.types.DlDefaultConfigurationRegister
- 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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.generated.zap_clusters.DoorLock.types.DlLocalProgrammingFeatures
the data type of this attribute
- new_value(...)
Create a DlLocalProgrammingFeatures 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 DlLocalProgrammingFeatures- Return type
st.matter.generated.zap_clusters.DoorLock.types.DlLocalProgrammingFeatures
- 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.generated.zap_clusters.DoorLock.types.DlLocalProgrammingFeatures) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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) – 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 forendpoint_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
- 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.Uint16) – 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 forendpoint_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.AliroReaderVerificationKey
- ID: number
0x0080 the ID of this attribute
- NAME: str
“AliroReaderVerificationKey” the name of this attribute
- data_type: st.matter.data_types.OctetString1
the data type of this attribute
- new_value(...)
Create a OctetString1 object of this attribute with any additional features provided for the attribute
This is also usable with the AliroReaderVerificationKey(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a OctetString1- Return type
- 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: AliroReaderVerificationKey => 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 AliroReaderVerificationKey test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.AliroReaderGroupIdentifier
- ID: number
0x0081 the ID of this attribute
- NAME: str
“AliroReaderGroupIdentifier” the name of this attribute
- data_type: st.matter.data_types.OctetString1
the data type of this attribute
- new_value(...)
Create a OctetString1 object of this attribute with any additional features provided for the attribute
This is also usable with the AliroReaderGroupIdentifier(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a OctetString1- Return type
- 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: AliroReaderGroupIdentifier => 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 AliroReaderGroupIdentifier test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.AliroReaderGroupSubIdentifier
- ID: number
0x0082 the ID of this attribute
- NAME: str
“AliroReaderGroupSubIdentifier” the name of this attribute
- data_type: st.matter.data_types.OctetString1
the data type of this attribute
- new_value(...)
Create a OctetString1 object of this attribute with any additional features provided for the attribute
This is also usable with the AliroReaderGroupSubIdentifier(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a OctetString1- Return type
- 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: AliroReaderGroupSubIdentifier => 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 AliroReaderGroupSubIdentifier test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.AliroExpeditedTransactionSupportedProtocolVersions
- ID: number
0x0083 the ID of this attribute
- NAME: str
“AliroExpeditedTransactionSupportedProtocolVersions” the name of this attribute
- data_type: st.matter.data_types.Array
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.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the AliroExpeditedTransactionSupportedProtocolVersions(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Array- Return type
- 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: AliroExpeditedTransactionSupportedProtocolVersions => 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 AliroExpeditedTransactionSupportedProtocolVersions test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.AliroGroupResolvingKey
- ID: number
0x0084 the ID of this attribute
- NAME: str
“AliroGroupResolvingKey” the name of this attribute
- data_type: st.matter.data_types.OctetString1
the data type of this attribute
- new_value(...)
Create a OctetString1 object of this attribute with any additional features provided for the attribute
This is also usable with the AliroGroupResolvingKey(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a OctetString1- Return type
- 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: AliroGroupResolvingKey => 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 AliroGroupResolvingKey test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.AliroSupportedBLEUWBProtocolVersions
- ID: number
0x0085 the ID of this attribute
- NAME: str
“AliroSupportedBLEUWBProtocolVersions” the name of this attribute
- data_type: st.matter.data_types.Array
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.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the AliroSupportedBLEUWBProtocolVersions(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Array- Return type
- 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: AliroSupportedBLEUWBProtocolVersions => 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 AliroSupportedBLEUWBProtocolVersions test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.AliroBLEAdvertisingVersion
- ID: number
0x0086 the ID of this attribute
- NAME: str
“AliroBLEAdvertisingVersion” 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 AliroBLEAdvertisingVersion(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Uint8- Return type
- 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: AliroBLEAdvertisingVersion => 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 AliroBLEAdvertisingVersion test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.NumberOfAliroCredentialIssuerKeysSupported
- ID: number
0x0087 the ID of this attribute
- NAME: str
“NumberOfAliroCredentialIssuerKeysSupported” 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 NumberOfAliroCredentialIssuerKeysSupported(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Uint16- Return type
- 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: NumberOfAliroCredentialIssuerKeysSupported => 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 NumberOfAliroCredentialIssuerKeysSupported test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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.NumberOfAliroEndpointKeysSupported
- ID: number
0x0088 the ID of this attribute
- NAME: str
“NumberOfAliroEndpointKeysSupported” 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 NumberOfAliroEndpointKeysSupported(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Uint16- Return type
- 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: NumberOfAliroEndpointKeysSupported => 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 NumberOfAliroEndpointKeysSupported test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- 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
- 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 forendpoint_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.EventList
- ID: number
0xFFFA the ID of this attribute
- NAME: str
“EventList” the name of this attribute
- data_type: st.matter.data_types.Array
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.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the EventList(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Array- Return type
- 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: EventList => 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 EventList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_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
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- 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
- 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 forendpoint_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: st.matter.data_types.Uint8
- user_index: st.matter.data_types.Uint16
- status: st.matter.generated.zap_clusters.DoorLock.types.DlStatus
- days_mask: st.matter.generated.zap_clusters.DoorLock.types.DaysMaskMap
- 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
- 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 toendpoint_id (
number or nil) –week_day_index (
st.matter.data_types.Uint8) –user_index (
st.matter.data_types.Uint16) –status (
st.matter.generated.zap_clusters.DoorLock.types.DlStatus) –days_mask (
st.matter.generated.zap_clusters.DoorLock.types.DaysMaskMap) –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 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: st.matter.data_types.Uint8
- user_index: st.matter.data_types.Uint16
- status: st.matter.generated.zap_clusters.DoorLock.types.DlStatus
- local_start_time: st.matter.data_types.Uint32
- local_end_time: st.matter.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 toendpoint_id (
number or nil) –year_day_index (
st.matter.data_types.Uint8) –user_index (
st.matter.data_types.Uint16) –status (
st.matter.generated.zap_clusters.DoorLock.types.DlStatus) –local_start_time (
st.matter.data_types.Uint32) –local_end_time (
st.matter.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: st.matter.data_types.Uint8
- status: st.matter.generated.zap_clusters.DoorLock.types.DlStatus
- local_start_time: st.matter.data_types.Uint32
- local_end_time: st.matter.data_types.Uint32
- operating_mode: st.matter.generated.zap_clusters.DoorLock.types.OperatingModeEnum
- 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 toendpoint_id (
number or nil) –holiday_index (
st.matter.data_types.Uint8) –status (
st.matter.generated.zap_clusters.DoorLock.types.DlStatus) –local_start_time (
st.matter.data_types.Uint32) –local_end_time (
st.matter.data_types.Uint32) –operating_mode (
st.matter.generated.zap_clusters.DoorLock.types.OperatingModeEnum) –
- 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: st.matter.data_types.Uint16
- user_name: st.matter.data_types.UTF8String1
- user_uniqueid: st.matter.data_types.Uint32
- user_status: st.matter.generated.zap_clusters.DoorLock.types.UserStatusEnum
- user_type: st.matter.generated.zap_clusters.DoorLock.types.UserTypeEnum
- credential_rule: st.matter.generated.zap_clusters.DoorLock.types.CredentialRuleEnum
- credentials: st.matter.data_types.Array
- creator_fabric_index: st.matter.data_types.Uint8
- last_modified_fabric_index: st.matter.data_types.Uint8
- next_user_index: st.matter.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_uniqueid, 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 toendpoint_id (
number or nil) –user_index (
st.matter.data_types.Uint16) –user_name (
st.matter.data_types.UTF8String1) –user_uniqueid (
st.matter.data_types.Uint32) –user_status (
st.matter.generated.zap_clusters.DoorLock.types.UserStatusEnum) –user_type (
st.matter.generated.zap_clusters.DoorLock.types.UserTypeEnum) –credential_rule (
st.matter.generated.zap_clusters.DoorLock.types.CredentialRuleEnum) –credentials (
st.matter.data_types.Array) –creator_fabric_index (
st.matter.data_types.Uint8) –last_modified_fabric_index (
st.matter.data_types.Uint8) –next_user_index (
st.matter.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.generated.zap_clusters.DoorLock.types.DlStatus
- user_index: st.matter.data_types.Uint16
- next_credential_index: st.matter.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 toendpoint_id (
number or nil) –status (
st.matter.generated.zap_clusters.DoorLock.types.DlStatus) –user_index (
st.matter.data_types.Uint16) –next_credential_index (
st.matter.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: st.matter.data_types.Boolean
- user_index: st.matter.data_types.Uint16
- creator_fabric_index: st.matter.data_types.Uint8
- last_modified_fabric_index: st.matter.data_types.Uint8
- next_credential_index: st.matter.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 toendpoint_id (
number or nil) –credential_exists (
st.matter.data_types.Boolean) –user_index (
st.matter.data_types.Uint16) –creator_fabric_index (
st.matter.data_types.Uint8) –last_modified_fabric_index (
st.matter.data_types.Uint8) –next_credential_index (
st.matter.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: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message topin_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: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message topin_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: st.matter.data_types.Uint16
- pin_code: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message totimeout (
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: st.matter.data_types.Uint8
- user_index: st.matter.data_types.Uint16
- days_mask: st.matter.generated.zap_clusters.DoorLock.types.DaysMaskMap
- 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
- 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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message toweek_day_index (
st.matter.data_types.Uint8) –user_index (
st.matter.data_types.Uint16) –days_mask (
st.matter.generated.zap_clusters.DoorLock.types.DaysMaskMap) –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: st.matter.data_types.Uint8
- user_index: st.matter.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 commanddevice (
st.matter.Device) – the device to build this message toweek_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: st.matter.data_types.Uint8
- user_index: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message toweek_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: 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
- 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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message toyear_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: st.matter.data_types.Uint8
- user_index: st.matter.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 commanddevice (
st.matter.Device) – the device to build this message toyear_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: st.matter.data_types.Uint8
- user_index: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message toyear_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: 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.generated.zap_clusters.DoorLock.types.OperatingModeEnum
- 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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message toholiday_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.generated.zap_clusters.DoorLock.types.OperatingModeEnum) –
- 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: st.matter.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 commanddevice (
st.matter.Device) – the device to build this message toholiday_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: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message toholiday_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.generated.zap_clusters.DoorLock.types.DataOperationTypeEnum
- user_index: st.matter.data_types.Uint16
- user_name: st.matter.data_types.UTF8String1
- user_uniqueid: st.matter.data_types.Uint32
- user_status: st.matter.generated.zap_clusters.DoorLock.types.UserStatusEnum
- user_type: st.matter.generated.zap_clusters.DoorLock.types.UserTypeEnum
- credential_rule: st.matter.generated.zap_clusters.DoorLock.types.CredentialRuleEnum
- 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 toendpoint_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_uniqueid, user_status, user_type, credential_rule)
Initialize the SetUser command
- Parameters
self (
SetUser) – the template class for this commanddevice (
st.matter.Device) – the device to build this message tooperation_type (
st.matter.generated.zap_clusters.DoorLock.types.DataOperationTypeEnum) –user_index (
st.matter.data_types.Uint16) –user_name (
st.matter.data_types.UTF8String1) –user_uniqueid (
st.matter.data_types.Uint32) –user_status (
st.matter.generated.zap_clusters.DoorLock.types.UserStatusEnum) –user_type (
st.matter.generated.zap_clusters.DoorLock.types.UserTypeEnum) –credential_rule (
st.matter.generated.zap_clusters.DoorLock.types.CredentialRuleEnum) –
- 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: st.matter.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 commanddevice (
st.matter.Device) – the device to build this message touser_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: st.matter.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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message touser_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.generated.zap_clusters.DoorLock.types.DataOperationTypeEnum
- credential: st.matter.generated.zap_clusters.DoorLock.types.CredentialStruct
- credential_data: st.matter.data_types.OctetString2
- user_index: st.matter.data_types.Uint16
- user_status: st.matter.generated.zap_clusters.DoorLock.types.UserStatusEnum
- user_type: st.matter.generated.zap_clusters.DoorLock.types.UserTypeEnum
- 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 commanddevice (
st.matter.Device) – the device to build this message tooperation_type (
st.matter.generated.zap_clusters.DoorLock.types.DataOperationTypeEnum) –credential (
st.matter.generated.zap_clusters.DoorLock.types.CredentialStruct) –credential_data (
st.matter.data_types.OctetString2) –user_index (
st.matter.data_types.Uint16) –user_status (
st.matter.generated.zap_clusters.DoorLock.types.UserStatusEnum) –user_type (
st.matter.generated.zap_clusters.DoorLock.types.UserTypeEnum) –
- 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.generated.zap_clusters.DoorLock.types.CredentialStruct
- 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 commanddevice (
st.matter.Device) – the device to build this message tocredential (
st.matter.generated.zap_clusters.DoorLock.types.CredentialStruct) –
- 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.generated.zap_clusters.DoorLock.types.CredentialStruct
- 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 toendpoint_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 commanddevice (
st.matter.Device) – the device to build this message tocredential (
st.matter.generated.zap_clusters.DoorLock.types.CredentialStruct) –
- 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.UnboltDoor
- ID: number
0x0027 the ID of this command
- NAME: str
“UnboltDoor” the name of this command
- pin_code: st.matter.data_types.OctetString1
- build_test_command_response(device, endpoint_id, status)
Builds an UnboltDoor test command reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message toendpoint_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 UnboltDoor command
- Parameters
self (
UnboltDoor) – the template class for this commanddevice (
st.matter.Device) – the device to build this message topin_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.SetAliroReaderConfig
- ID: number
0x0028 the ID of this command
- NAME: str
“SetAliroReaderConfig” the name of this command
- signing_key: st.matter.data_types.OctetString1
- verification_key: st.matter.data_types.OctetString1
- group_identifier: st.matter.data_types.OctetString1
- group_resolving_key: st.matter.data_types.OctetString1
- build_test_command_response(device, endpoint_id, status)
Builds an SetAliroReaderConfig test command reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message toendpoint_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, signing_key, verification_key, group_identifier, group_resolving_key)
Initialize the SetAliroReaderConfig command
- Parameters
self (
SetAliroReaderConfig) – the template class for this commanddevice (
st.matter.Device) – the device to build this message tosigning_key (
st.matter.data_types.OctetString1) –verification_key (
st.matter.data_types.OctetString1) –group_identifier (
st.matter.data_types.OctetString1) –group_resolving_key (
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.ClearAliroReaderConfig
- ID: number
0x0029 the ID of this command
- NAME: str
“ClearAliroReaderConfig” the name of this command
- build_test_command_response(device, endpoint_id, status)
Builds an ClearAliroReaderConfig test command reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message toendpoint_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)
Initialize the ClearAliroReaderConfig command
- Parameters
self (
ClearAliroReaderConfig) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- 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.generated.zap_clusters.DoorLock.types.AlarmCodeEnum
- 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 forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
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.generated.zap_clusters.DoorLock.types.DoorStateEnum
- 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 forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
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.generated.zap_clusters.DoorLock.types.LockOperationTypeEnum
- operation_source: st.matter.generated.zap_clusters.DoorLock.types.OperationSourceEnum
- user_index: st.matter.data_types.Uint16
- fabric_index: st.matter.data_types.Uint8
- source_node: st.matter.data_types.Uint64
- credentials: st.matter.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 forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
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.generated.zap_clusters.DoorLock.types.LockOperationTypeEnum
- operation_source: st.matter.generated.zap_clusters.DoorLock.types.OperationSourceEnum
- operation_error: st.matter.generated.zap_clusters.DoorLock.types.OperationErrorEnum
- user_index: st.matter.data_types.Uint16
- fabric_index: st.matter.data_types.Uint8
- source_node: st.matter.data_types.Uint64
- credentials: st.matter.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 forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
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.generated.zap_clusters.DoorLock.types.LockDataTypeEnum
- data_operation_type: st.matter.generated.zap_clusters.DoorLock.types.DataOperationTypeEnum
- operation_source: st.matter.generated.zap_clusters.DoorLock.types.OperationSourceEnum
- user_index: st.matter.data_types.Uint16
- fabric_index: st.matter.data_types.Uint8
- source_node: st.matter.data_types.Uint64
- data_index: st.matter.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 forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
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) –
Bitmap types
- class st.matter.clusters.DoorLock.types.DaysMaskMap
- SUNDAY: number
1
- MONDAY: number
2
- TUESDAY: number
4
- WEDNESDAY: number
8
- THURSDAY: number
16
- FRIDAY: number
32
- SATURDAY: number
64
- is_sunday_set()
- Returns
True if the value of SUNDAY is non-zero
- Return type
boolean
- set_sunday()
Set the value of the bit in the SUNDAY field to 1
- unset_sunday()
Set the value of the bits in the SUNDAY field to 0
- is_monday_set()
- Returns
True if the value of MONDAY is non-zero
- Return type
boolean
- set_monday()
Set the value of the bit in the MONDAY field to 1
- unset_monday()
Set the value of the bits in the MONDAY field to 0
- is_tuesday_set()
- Returns
True if the value of TUESDAY is non-zero
- Return type
boolean
- set_tuesday()
Set the value of the bit in the TUESDAY field to 1
- unset_tuesday()
Set the value of the bits in the TUESDAY field to 0
- is_wednesday_set()
- Returns
True if the value of WEDNESDAY is non-zero
- Return type
boolean
- set_wednesday()
Set the value of the bit in the WEDNESDAY field to 1
- unset_wednesday()
Set the value of the bits in the WEDNESDAY field to 0
- is_thursday_set()
- Returns
True if the value of THURSDAY is non-zero
- Return type
boolean
- set_thursday()
Set the value of the bit in the THURSDAY field to 1
- unset_thursday()
Set the value of the bits in the THURSDAY field to 0
- is_friday_set()
- Returns
True if the value of FRIDAY is non-zero
- Return type
boolean
- set_friday()
Set the value of the bit in the FRIDAY field to 1
- unset_friday()
Set the value of the bits in the FRIDAY field to 0
- is_saturday_set()
- Returns
True if the value of SATURDAY is non-zero
- Return type
boolean
- set_saturday()
Set the value of the bit in the SATURDAY field to 1
- unset_saturday()
Set the value of the bits in the SATURDAY field to 0
- class st.matter.clusters.DoorLock.types.DlCredentialRuleMask
- SINGLE: number
1
- DUAL: number
2
- TRI: number
4
- is_single_set()
- Returns
True if the value of SINGLE is non-zero
- Return type
boolean
- set_single()
Set the value of the bit in the SINGLE field to 1
- unset_single()
Set the value of the bits in the SINGLE field to 0
- is_dual_set()
- Returns
True if the value of DUAL is non-zero
- Return type
boolean
- set_dual()
Set the value of the bit in the DUAL field to 1
- unset_dual()
Set the value of the bits in the DUAL field to 0
- is_tri_set()
- Returns
True if the value of TRI is non-zero
- Return type
boolean
- set_tri()
Set the value of the bit in the TRI field to 1
- unset_tri()
Set the value of the bits in the TRI field to 0
- class st.matter.clusters.DoorLock.types.DlCredentialRulesSupport
- SINGLE: number
1
- DUAL: number
2
- TRI: number
4
- is_single_set()
- Returns
True if the value of SINGLE is non-zero
- Return type
boolean
- set_single()
Set the value of the bit in the SINGLE field to 1
- unset_single()
Set the value of the bits in the SINGLE field to 0
- is_dual_set()
- Returns
True if the value of DUAL is non-zero
- Return type
boolean
- set_dual()
Set the value of the bit in the DUAL field to 1
- unset_dual()
Set the value of the bits in the DUAL field to 0
- is_tri_set()
- Returns
True if the value of TRI is non-zero
- Return type
boolean
- set_tri()
Set the value of the bit in the TRI field to 1
- unset_tri()
Set the value of the bits in the TRI field to 0
- class st.matter.clusters.DoorLock.types.DlDefaultConfigurationRegister
- ENABLE_LOCAL_PROGRAMMING_ENABLED: number
1
- KEYPAD_INTERFACE_DEFAULT_ACCESS_ENABLED: number
2
- REMOTE_INTERFACE_DEFAULT_ACCESS_IS_ENABLED: number
4
- SOUND_ENABLED: number
32
- AUTO_RELOCK_TIME_SET: number
64
- LED_SETTINGS_SET: number
128
- is_enable_local_programming_enabled_set()
- Returns
True if the value of ENABLE_LOCAL_PROGRAMMING_ENABLED is non-zero
- Return type
boolean
- set_enable_local_programming_enabled()
Set the value of the bit in the ENABLE_LOCAL_PROGRAMMING_ENABLED field to 1
- unset_enable_local_programming_enabled()
Set the value of the bits in the ENABLE_LOCAL_PROGRAMMING_ENABLED field to 0
- is_keypad_interface_default_access_enabled_set()
- Returns
True if the value of KEYPAD_INTERFACE_DEFAULT_ACCESS_ENABLED is non-zero
- Return type
boolean
- set_keypad_interface_default_access_enabled()
Set the value of the bit in the KEYPAD_INTERFACE_DEFAULT_ACCESS_ENABLED field to 1
- unset_keypad_interface_default_access_enabled()
Set the value of the bits in the KEYPAD_INTERFACE_DEFAULT_ACCESS_ENABLED field to 0
- is_remote_interface_default_access_is_enabled_set()
- Returns
True if the value of REMOTE_INTERFACE_DEFAULT_ACCESS_IS_ENABLED is non-zero
- Return type
boolean
- set_remote_interface_default_access_is_enabled()
Set the value of the bit in the REMOTE_INTERFACE_DEFAULT_ACCESS_IS_ENABLED field to 1
- unset_remote_interface_default_access_is_enabled()
Set the value of the bits in the REMOTE_INTERFACE_DEFAULT_ACCESS_IS_ENABLED field to 0
- is_sound_enabled_set()
- Returns
True if the value of SOUND_ENABLED is non-zero
- Return type
boolean
- set_sound_enabled()
Set the value of the bit in the SOUND_ENABLED field to 1
- unset_sound_enabled()
Set the value of the bits in the SOUND_ENABLED field to 0
- is_auto_relock_time_set_set()
- Returns
True if the value of AUTO_RELOCK_TIME_SET is non-zero
- Return type
boolean
- set_auto_relock_time_set()
Set the value of the bit in the AUTO_RELOCK_TIME_SET field to 1
- unset_auto_relock_time_set()
Set the value of the bits in the AUTO_RELOCK_TIME_SET field to 0
- is_led_settings_set_set()
- Returns
True if the value of LED_SETTINGS_SET is non-zero
- Return type
boolean
- set_led_settings_set()
Set the value of the bit in the LED_SETTINGS_SET field to 1
- unset_led_settings_set()
Set the value of the bits in the LED_SETTINGS_SET field to 0
- class st.matter.clusters.DoorLock.types.DlKeypadOperationEventMask
- UNKNOWN: number
1
- LOCK: number
2
- UNLOCK: number
4
- LOCK_INVALIDPIN: number
8
- LOCK_INVALID_SCHEDULE: number
16
- UNLOCK_INVALID_CODE: number
32
- UNLOCK_INVALID_SCHEDULE: number
64
- NON_ACCESS_USER_OP_EVENT: number
128
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_lock_set()
- Returns
True if the value of LOCK is non-zero
- Return type
boolean
- set_lock()
Set the value of the bit in the LOCK field to 1
- unset_lock()
Set the value of the bits in the LOCK field to 0
- is_unlock_set()
- Returns
True if the value of UNLOCK is non-zero
- Return type
boolean
- set_unlock()
Set the value of the bit in the UNLOCK field to 1
- unset_unlock()
Set the value of the bits in the UNLOCK field to 0
- is_lock_invalidpin_set()
- Returns
True if the value of LOCK_INVALIDPIN is non-zero
- Return type
boolean
- set_lock_invalidpin()
Set the value of the bit in the LOCK_INVALIDPIN field to 1
- unset_lock_invalidpin()
Set the value of the bits in the LOCK_INVALIDPIN field to 0
- is_lock_invalid_schedule_set()
- Returns
True if the value of LOCK_INVALID_SCHEDULE is non-zero
- Return type
boolean
- set_lock_invalid_schedule()
Set the value of the bit in the LOCK_INVALID_SCHEDULE field to 1
- unset_lock_invalid_schedule()
Set the value of the bits in the LOCK_INVALID_SCHEDULE field to 0
- is_unlock_invalid_code_set()
- Returns
True if the value of UNLOCK_INVALID_CODE is non-zero
- Return type
boolean
- set_unlock_invalid_code()
Set the value of the bit in the UNLOCK_INVALID_CODE field to 1
- unset_unlock_invalid_code()
Set the value of the bits in the UNLOCK_INVALID_CODE field to 0
- is_unlock_invalid_schedule_set()
- Returns
True if the value of UNLOCK_INVALID_SCHEDULE is non-zero
- Return type
boolean
- set_unlock_invalid_schedule()
Set the value of the bit in the UNLOCK_INVALID_SCHEDULE field to 1
- unset_unlock_invalid_schedule()
Set the value of the bits in the UNLOCK_INVALID_SCHEDULE field to 0
- is_non_access_user_op_event_set()
- Returns
True if the value of NON_ACCESS_USER_OP_EVENT is non-zero
- Return type
boolean
- set_non_access_user_op_event()
Set the value of the bit in the NON_ACCESS_USER_OP_EVENT field to 1
- unset_non_access_user_op_event()
Set the value of the bits in the NON_ACCESS_USER_OP_EVENT field to 0
- class st.matter.clusters.DoorLock.types.DlKeypadProgrammingEventMask
- UNKNOWN: number
1
- PROGRAMMINGPIN_CHANGED: number
2
- PIN_ADDED: number
4
- PIN_CLEARED: number
8
- PIN_CHANGED: number
16
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_programmingpin_changed_set()
- Returns
True if the value of PROGRAMMINGPIN_CHANGED is non-zero
- Return type
boolean
- set_programmingpin_changed()
Set the value of the bit in the PROGRAMMINGPIN_CHANGED field to 1
- unset_programmingpin_changed()
Set the value of the bits in the PROGRAMMINGPIN_CHANGED field to 0
- is_pin_added_set()
- Returns
True if the value of PIN_ADDED is non-zero
- Return type
boolean
- set_pin_added()
Set the value of the bit in the PIN_ADDED field to 1
- unset_pin_added()
Set the value of the bits in the PIN_ADDED field to 0
- is_pin_cleared_set()
- Returns
True if the value of PIN_CLEARED is non-zero
- Return type
boolean
- set_pin_cleared()
Set the value of the bit in the PIN_CLEARED field to 1
- unset_pin_cleared()
Set the value of the bits in the PIN_CLEARED field to 0
- is_pin_changed_set()
- Returns
True if the value of PIN_CHANGED is non-zero
- Return type
boolean
- set_pin_changed()
Set the value of the bit in the PIN_CHANGED field to 1
- unset_pin_changed()
Set the value of the bits in the PIN_CHANGED field to 0
- class st.matter.clusters.DoorLock.types.DlLocalProgrammingFeatures
- ADD_USERS_CREDENTIALS_SCHEDULES_LOCALLY: number
1
- MODIFY_USERS_CREDENTIALS_SCHEDULES_LOCALLY: number
2
- CLEAR_USERS_CREDENTIALS_SCHEDULES_LOCALLY: number
4
- ADJUST_LOCK_SETTINGS_LOCALLY: number
8
- is_add_users_credentials_schedules_locally_set()
- Returns
True if the value of ADD_USERS_CREDENTIALS_SCHEDULES_LOCALLY is non-zero
- Return type
boolean
- set_add_users_credentials_schedules_locally()
Set the value of the bit in the ADD_USERS_CREDENTIALS_SCHEDULES_LOCALLY field to 1
- unset_add_users_credentials_schedules_locally()
Set the value of the bits in the ADD_USERS_CREDENTIALS_SCHEDULES_LOCALLY field to 0
- is_modify_users_credentials_schedules_locally_set()
- Returns
True if the value of MODIFY_USERS_CREDENTIALS_SCHEDULES_LOCALLY is non-zero
- Return type
boolean
- set_modify_users_credentials_schedules_locally()
Set the value of the bit in the MODIFY_USERS_CREDENTIALS_SCHEDULES_LOCALLY field to 1
- unset_modify_users_credentials_schedules_locally()
Set the value of the bits in the MODIFY_USERS_CREDENTIALS_SCHEDULES_LOCALLY field to 0
- is_clear_users_credentials_schedules_locally_set()
- Returns
True if the value of CLEAR_USERS_CREDENTIALS_SCHEDULES_LOCALLY is non-zero
- Return type
boolean
- set_clear_users_credentials_schedules_locally()
Set the value of the bit in the CLEAR_USERS_CREDENTIALS_SCHEDULES_LOCALLY field to 1
- unset_clear_users_credentials_schedules_locally()
Set the value of the bits in the CLEAR_USERS_CREDENTIALS_SCHEDULES_LOCALLY field to 0
- is_adjust_lock_settings_locally_set()
- Returns
True if the value of ADJUST_LOCK_SETTINGS_LOCALLY is non-zero
- Return type
boolean
- set_adjust_lock_settings_locally()
Set the value of the bit in the ADJUST_LOCK_SETTINGS_LOCALLY field to 1
- unset_adjust_lock_settings_locally()
Set the value of the bits in the ADJUST_LOCK_SETTINGS_LOCALLY field to 0
- class st.matter.clusters.DoorLock.types.DlManualOperationEventMask
- UNKNOWN: number
1
- THUMBTURN_LOCK: number
2
- THUMBTURN_UNLOCK: number
4
- ONE_TOUCH_LOCK: number
8
- KEY_LOCK: number
16
- KEY_UNLOCK: number
32
- AUTO_LOCK: number
64
- SCHEDULE_LOCK: number
128
- SCHEDULE_UNLOCK: number
256
- MANUAL_LOCK: number
512
- MANUAL_UNLOCK: number
1024
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_thumbturn_lock_set()
- Returns
True if the value of THUMBTURN_LOCK is non-zero
- Return type
boolean
- set_thumbturn_lock()
Set the value of the bit in the THUMBTURN_LOCK field to 1
- unset_thumbturn_lock()
Set the value of the bits in the THUMBTURN_LOCK field to 0
- is_thumbturn_unlock_set()
- Returns
True if the value of THUMBTURN_UNLOCK is non-zero
- Return type
boolean
- set_thumbturn_unlock()
Set the value of the bit in the THUMBTURN_UNLOCK field to 1
- unset_thumbturn_unlock()
Set the value of the bits in the THUMBTURN_UNLOCK field to 0
- is_one_touch_lock_set()
- Returns
True if the value of ONE_TOUCH_LOCK is non-zero
- Return type
boolean
- set_one_touch_lock()
Set the value of the bit in the ONE_TOUCH_LOCK field to 1
- unset_one_touch_lock()
Set the value of the bits in the ONE_TOUCH_LOCK field to 0
- is_key_lock_set()
- Returns
True if the value of KEY_LOCK is non-zero
- Return type
boolean
- set_key_lock()
Set the value of the bit in the KEY_LOCK field to 1
- unset_key_lock()
Set the value of the bits in the KEY_LOCK field to 0
- is_key_unlock_set()
- Returns
True if the value of KEY_UNLOCK is non-zero
- Return type
boolean
- set_key_unlock()
Set the value of the bit in the KEY_UNLOCK field to 1
- unset_key_unlock()
Set the value of the bits in the KEY_UNLOCK field to 0
- is_auto_lock_set()
- Returns
True if the value of AUTO_LOCK is non-zero
- Return type
boolean
- set_auto_lock()
Set the value of the bit in the AUTO_LOCK field to 1
- unset_auto_lock()
Set the value of the bits in the AUTO_LOCK field to 0
- is_schedule_lock_set()
- Returns
True if the value of SCHEDULE_LOCK is non-zero
- Return type
boolean
- set_schedule_lock()
Set the value of the bit in the SCHEDULE_LOCK field to 1
- unset_schedule_lock()
Set the value of the bits in the SCHEDULE_LOCK field to 0
- is_schedule_unlock_set()
- Returns
True if the value of SCHEDULE_UNLOCK is non-zero
- Return type
boolean
- set_schedule_unlock()
Set the value of the bit in the SCHEDULE_UNLOCK field to 1
- unset_schedule_unlock()
Set the value of the bits in the SCHEDULE_UNLOCK field to 0
- is_manual_lock_set()
- Returns
True if the value of MANUAL_LOCK is non-zero
- Return type
boolean
- set_manual_lock()
Set the value of the bit in the MANUAL_LOCK field to 1
- unset_manual_lock()
Set the value of the bits in the MANUAL_LOCK field to 0
- is_manual_unlock_set()
- Returns
True if the value of MANUAL_UNLOCK is non-zero
- Return type
boolean
- set_manual_unlock()
Set the value of the bit in the MANUAL_UNLOCK field to 1
- unset_manual_unlock()
Set the value of the bits in the MANUAL_UNLOCK field to 0
- class st.matter.clusters.DoorLock.types.DlRFIDOperationEventMask
- UNKNOWN: number
1
- LOCK: number
2
- UNLOCK: number
4
- LOCK_INVALIDRFID: number
8
- LOCK_INVALID_SCHEDULE: number
16
- UNLOCK_INVALIDRFID: number
32
- UNLOCK_INVALID_SCHEDULE: number
64
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_lock_set()
- Returns
True if the value of LOCK is non-zero
- Return type
boolean
- set_lock()
Set the value of the bit in the LOCK field to 1
- unset_lock()
Set the value of the bits in the LOCK field to 0
- is_unlock_set()
- Returns
True if the value of UNLOCK is non-zero
- Return type
boolean
- set_unlock()
Set the value of the bit in the UNLOCK field to 1
- unset_unlock()
Set the value of the bits in the UNLOCK field to 0
- is_lock_invalidrfid_set()
- Returns
True if the value of LOCK_INVALIDRFID is non-zero
- Return type
boolean
- set_lock_invalidrfid()
Set the value of the bit in the LOCK_INVALIDRFID field to 1
- unset_lock_invalidrfid()
Set the value of the bits in the LOCK_INVALIDRFID field to 0
- is_lock_invalid_schedule_set()
- Returns
True if the value of LOCK_INVALID_SCHEDULE is non-zero
- Return type
boolean
- set_lock_invalid_schedule()
Set the value of the bit in the LOCK_INVALID_SCHEDULE field to 1
- unset_lock_invalid_schedule()
Set the value of the bits in the LOCK_INVALID_SCHEDULE field to 0
- is_unlock_invalidrfid_set()
- Returns
True if the value of UNLOCK_INVALIDRFID is non-zero
- Return type
boolean
- set_unlock_invalidrfid()
Set the value of the bit in the UNLOCK_INVALIDRFID field to 1
- unset_unlock_invalidrfid()
Set the value of the bits in the UNLOCK_INVALIDRFID field to 0
- is_unlock_invalid_schedule_set()
- Returns
True if the value of UNLOCK_INVALID_SCHEDULE is non-zero
- Return type
boolean
- set_unlock_invalid_schedule()
Set the value of the bit in the UNLOCK_INVALID_SCHEDULE field to 1
- unset_unlock_invalid_schedule()
Set the value of the bits in the UNLOCK_INVALID_SCHEDULE field to 0
- class st.matter.clusters.DoorLock.types.DlRFIDProgrammingEventMask
- UNKNOWN: number
1
- RFID_CODE_ADDED: number
32
- RFID_CODE_CLEARED: number
64
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_rfid_code_added_set()
- Returns
True if the value of RFID_CODE_ADDED is non-zero
- Return type
boolean
- set_rfid_code_added()
Set the value of the bit in the RFID_CODE_ADDED field to 1
- unset_rfid_code_added()
Set the value of the bits in the RFID_CODE_ADDED field to 0
- is_rfid_code_cleared_set()
- Returns
True if the value of RFID_CODE_CLEARED is non-zero
- Return type
boolean
- set_rfid_code_cleared()
Set the value of the bit in the RFID_CODE_CLEARED field to 1
- unset_rfid_code_cleared()
Set the value of the bits in the RFID_CODE_CLEARED field to 0
- class st.matter.clusters.DoorLock.types.DlRemoteOperationEventMask
- UNKNOWN: number
1
- LOCK: number
2
- UNLOCK: number
4
- LOCK_INVALID_CODE: number
8
- LOCK_INVALID_SCHEDULE: number
16
- UNLOCK_INVALID_CODE: number
32
- UNLOCK_INVALID_SCHEDULE: number
64
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_lock_set()
- Returns
True if the value of LOCK is non-zero
- Return type
boolean
- set_lock()
Set the value of the bit in the LOCK field to 1
- unset_lock()
Set the value of the bits in the LOCK field to 0
- is_unlock_set()
- Returns
True if the value of UNLOCK is non-zero
- Return type
boolean
- set_unlock()
Set the value of the bit in the UNLOCK field to 1
- unset_unlock()
Set the value of the bits in the UNLOCK field to 0
- is_lock_invalid_code_set()
- Returns
True if the value of LOCK_INVALID_CODE is non-zero
- Return type
boolean
- set_lock_invalid_code()
Set the value of the bit in the LOCK_INVALID_CODE field to 1
- unset_lock_invalid_code()
Set the value of the bits in the LOCK_INVALID_CODE field to 0
- is_lock_invalid_schedule_set()
- Returns
True if the value of LOCK_INVALID_SCHEDULE is non-zero
- Return type
boolean
- set_lock_invalid_schedule()
Set the value of the bit in the LOCK_INVALID_SCHEDULE field to 1
- unset_lock_invalid_schedule()
Set the value of the bits in the LOCK_INVALID_SCHEDULE field to 0
- is_unlock_invalid_code_set()
- Returns
True if the value of UNLOCK_INVALID_CODE is non-zero
- Return type
boolean
- set_unlock_invalid_code()
Set the value of the bit in the UNLOCK_INVALID_CODE field to 1
- unset_unlock_invalid_code()
Set the value of the bits in the UNLOCK_INVALID_CODE field to 0
- is_unlock_invalid_schedule_set()
- Returns
True if the value of UNLOCK_INVALID_SCHEDULE is non-zero
- Return type
boolean
- set_unlock_invalid_schedule()
Set the value of the bit in the UNLOCK_INVALID_SCHEDULE field to 1
- unset_unlock_invalid_schedule()
Set the value of the bits in the UNLOCK_INVALID_SCHEDULE field to 0
- class st.matter.clusters.DoorLock.types.DlRemoteProgrammingEventMask
- UNKNOWN: number
1
- PROGRAMMINGPIN_CHANGED: number
2
- PIN_ADDED: number
4
- PIN_CLEARED: number
8
- PIN_CHANGED: number
16
- RFID_CODE_ADDED: number
32
- RFID_CODE_CLEARED: number
64
- is_unknown_set()
- Returns
True if the value of UNKNOWN is non-zero
- Return type
boolean
- set_unknown()
Set the value of the bit in the UNKNOWN field to 1
- unset_unknown()
Set the value of the bits in the UNKNOWN field to 0
- is_programmingpin_changed_set()
- Returns
True if the value of PROGRAMMINGPIN_CHANGED is non-zero
- Return type
boolean
- set_programmingpin_changed()
Set the value of the bit in the PROGRAMMINGPIN_CHANGED field to 1
- unset_programmingpin_changed()
Set the value of the bits in the PROGRAMMINGPIN_CHANGED field to 0
- is_pin_added_set()
- Returns
True if the value of PIN_ADDED is non-zero
- Return type
boolean
- set_pin_added()
Set the value of the bit in the PIN_ADDED field to 1
- unset_pin_added()
Set the value of the bits in the PIN_ADDED field to 0
- is_pin_cleared_set()
- Returns
True if the value of PIN_CLEARED is non-zero
- Return type
boolean
- set_pin_cleared()
Set the value of the bit in the PIN_CLEARED field to 1
- unset_pin_cleared()
Set the value of the bits in the PIN_CLEARED field to 0
- is_pin_changed_set()
- Returns
True if the value of PIN_CHANGED is non-zero
- Return type
boolean
- set_pin_changed()
Set the value of the bit in the PIN_CHANGED field to 1
- unset_pin_changed()
Set the value of the bits in the PIN_CHANGED field to 0
- is_rfid_code_added_set()
- Returns
True if the value of RFID_CODE_ADDED is non-zero
- Return type
boolean
- set_rfid_code_added()
Set the value of the bit in the RFID_CODE_ADDED field to 1
- unset_rfid_code_added()
Set the value of the bits in the RFID_CODE_ADDED field to 0
- is_rfid_code_cleared_set()
- Returns
True if the value of RFID_CODE_CLEARED is non-zero
- Return type
boolean
- set_rfid_code_cleared()
Set the value of the bit in the RFID_CODE_CLEARED field to 1
- unset_rfid_code_cleared()
Set the value of the bits in the RFID_CODE_CLEARED field to 0
- class st.matter.clusters.DoorLock.types.DlSupportedOperatingModes
- NORMAL: number
1
- VACATION: number
2
- PRIVACY: number
4
- NO_REMOTE_LOCK_UNLOCK: number
8
- PASSAGE: number
16
- is_normal_set()
- Returns
True if the value of NORMAL is non-zero
- Return type
boolean
- set_normal()
Set the value of the bit in the NORMAL field to 1
- unset_normal()
Set the value of the bits in the NORMAL field to 0
- is_vacation_set()
- Returns
True if the value of VACATION is non-zero
- Return type
boolean
- set_vacation()
Set the value of the bit in the VACATION field to 1
- unset_vacation()
Set the value of the bits in the VACATION field to 0
- is_privacy_set()
- Returns
True if the value of PRIVACY is non-zero
- Return type
boolean
- set_privacy()
Set the value of the bit in the PRIVACY field to 1
- unset_privacy()
Set the value of the bits in the PRIVACY field to 0
- is_no_remote_lock_unlock_set()
- Returns
True if the value of NO_REMOTE_LOCK_UNLOCK is non-zero
- Return type
boolean
- set_no_remote_lock_unlock()
Set the value of the bit in the NO_REMOTE_LOCK_UNLOCK field to 1
- unset_no_remote_lock_unlock()
Set the value of the bits in the NO_REMOTE_LOCK_UNLOCK field to 0
- is_passage_set()
- Returns
True if the value of PASSAGE is non-zero
- Return type
boolean
- set_passage()
Set the value of the bit in the PASSAGE field to 1
- unset_passage()
Set the value of the bits in the PASSAGE field to 0
- class st.matter.clusters.DoorLock.types.DoorLockDayOfWeek
- SUNDAY: number
1
- MONDAY: number
2
- TUESDAY: number
4
- WEDNESDAY: number
8
- THURSDAY: number
16
- FRIDAY: number
32
- SATURDAY: number
64
- is_sunday_set()
- Returns
True if the value of SUNDAY is non-zero
- Return type
boolean
- set_sunday()
Set the value of the bit in the SUNDAY field to 1
- unset_sunday()
Set the value of the bits in the SUNDAY field to 0
- is_monday_set()
- Returns
True if the value of MONDAY is non-zero
- Return type
boolean
- set_monday()
Set the value of the bit in the MONDAY field to 1
- unset_monday()
Set the value of the bits in the MONDAY field to 0
- is_tuesday_set()
- Returns
True if the value of TUESDAY is non-zero
- Return type
boolean
- set_tuesday()
Set the value of the bit in the TUESDAY field to 1
- unset_tuesday()
Set the value of the bits in the TUESDAY field to 0
- is_wednesday_set()
- Returns
True if the value of WEDNESDAY is non-zero
- Return type
boolean
- set_wednesday()
Set the value of the bit in the WEDNESDAY field to 1
- unset_wednesday()
Set the value of the bits in the WEDNESDAY field to 0
- is_thursday_set()
- Returns
True if the value of THURSDAY is non-zero
- Return type
boolean
- set_thursday()
Set the value of the bit in the THURSDAY field to 1
- unset_thursday()
Set the value of the bits in the THURSDAY field to 0
- is_friday_set()
- Returns
True if the value of FRIDAY is non-zero
- Return type
boolean
- set_friday()
Set the value of the bit in the FRIDAY field to 1
- unset_friday()
Set the value of the bits in the FRIDAY field to 0
- is_saturday_set()
- Returns
True if the value of SATURDAY is non-zero
- Return type
boolean
- set_saturday()
Set the value of the bit in the SATURDAY field to 1
- unset_saturday()
Set the value of the bits in the SATURDAY field to 0
- class st.matter.clusters.DoorLock.types.Feature
- PIN_CREDENTIAL: number
1
- RFID_CREDENTIAL: number
2
- FINGER_CREDENTIALS: number
4
- LOGGING: number
8
- WEEK_DAY_ACCESS_SCHEDULES: number
16
- DOOR_POSITION_SENSOR: number
32
- FACE_CREDENTIALS: number
64
- CREDENTIALS_OVER_THE_AIR_ACCESS: number
128
- USER: number
256
- NOTIFICATION: number
512
- YEAR_DAY_ACCESS_SCHEDULES: number
1024
- HOLIDAY_SCHEDULES: number
2048
- UNBOLT: number
4096
- ALIRO_PROVISIONING: number
8192
- ALIROBLEUWB: number
16384
- is_pin_credential_set()
- Returns
True if the value of PIN_CREDENTIAL is non-zero
- Return type
boolean
- set_pin_credential()
Set the value of the bit in the PIN_CREDENTIAL field to 1
- unset_pin_credential()
Set the value of the bits in the PIN_CREDENTIAL field to 0
- is_rfid_credential_set()
- Returns
True if the value of RFID_CREDENTIAL is non-zero
- Return type
boolean
- set_rfid_credential()
Set the value of the bit in the RFID_CREDENTIAL field to 1
- unset_rfid_credential()
Set the value of the bits in the RFID_CREDENTIAL field to 0
- is_finger_credentials_set()
- Returns
True if the value of FINGER_CREDENTIALS is non-zero
- Return type
boolean
- set_finger_credentials()
Set the value of the bit in the FINGER_CREDENTIALS field to 1
- unset_finger_credentials()
Set the value of the bits in the FINGER_CREDENTIALS field to 0
- is_logging_set()
- Returns
True if the value of LOGGING is non-zero
- Return type
boolean
- set_logging()
Set the value of the bit in the LOGGING field to 1
- unset_logging()
Set the value of the bits in the LOGGING field to 0
- is_week_day_access_schedules_set()
- Returns
True if the value of WEEK_DAY_ACCESS_SCHEDULES is non-zero
- Return type
boolean
- set_week_day_access_schedules()
Set the value of the bit in the WEEK_DAY_ACCESS_SCHEDULES field to 1
- unset_week_day_access_schedules()
Set the value of the bits in the WEEK_DAY_ACCESS_SCHEDULES field to 0
- is_door_position_sensor_set()
- Returns
True if the value of DOOR_POSITION_SENSOR is non-zero
- Return type
boolean
- set_door_position_sensor()
Set the value of the bit in the DOOR_POSITION_SENSOR field to 1
- unset_door_position_sensor()
Set the value of the bits in the DOOR_POSITION_SENSOR field to 0
- is_face_credentials_set()
- Returns
True if the value of FACE_CREDENTIALS is non-zero
- Return type
boolean
- set_face_credentials()
Set the value of the bit in the FACE_CREDENTIALS field to 1
- unset_face_credentials()
Set the value of the bits in the FACE_CREDENTIALS field to 0
- is_credentials_over_the_air_access_set()
- Returns
True if the value of CREDENTIALS_OVER_THE_AIR_ACCESS is non-zero
- Return type
boolean
- set_credentials_over_the_air_access()
Set the value of the bit in the CREDENTIALS_OVER_THE_AIR_ACCESS field to 1
- unset_credentials_over_the_air_access()
Set the value of the bits in the CREDENTIALS_OVER_THE_AIR_ACCESS field to 0
- is_user_set()
- Returns
True if the value of USER is non-zero
- Return type
boolean
- set_user()
Set the value of the bit in the USER field to 1
- unset_user()
Set the value of the bits in the USER field to 0
- is_notification_set()
- Returns
True if the value of NOTIFICATION is non-zero
- Return type
boolean
- set_notification()
Set the value of the bit in the NOTIFICATION field to 1
- unset_notification()
Set the value of the bits in the NOTIFICATION field to 0
- is_year_day_access_schedules_set()
- Returns
True if the value of YEAR_DAY_ACCESS_SCHEDULES is non-zero
- Return type
boolean
- set_year_day_access_schedules()
Set the value of the bit in the YEAR_DAY_ACCESS_SCHEDULES field to 1
- unset_year_day_access_schedules()
Set the value of the bits in the YEAR_DAY_ACCESS_SCHEDULES field to 0
- is_holiday_schedules_set()
- Returns
True if the value of HOLIDAY_SCHEDULES is non-zero
- Return type
boolean
- set_holiday_schedules()
Set the value of the bit in the HOLIDAY_SCHEDULES field to 1
- unset_holiday_schedules()
Set the value of the bits in the HOLIDAY_SCHEDULES field to 0
- is_unbolt_set()
- Returns
True if the value of UNBOLT is non-zero
- Return type
boolean
- set_unbolt()
Set the value of the bit in the UNBOLT field to 1
- unset_unbolt()
Set the value of the bits in the UNBOLT field to 0
- is_aliro_provisioning_set()
- Returns
True if the value of ALIRO_PROVISIONING is non-zero
- Return type
boolean
- set_aliro_provisioning()
Set the value of the bit in the ALIRO_PROVISIONING field to 1
- unset_aliro_provisioning()
Set the value of the bits in the ALIRO_PROVISIONING field to 0
- is_alirobleuwb_set()
- Returns
True if the value of ALIROBLEUWB is non-zero
- Return type
boolean
- set_alirobleuwb()
Set the value of the bit in the ALIROBLEUWB field to 1
- unset_alirobleuwb()
Set the value of the bits in the ALIROBLEUWB field to 0
Enum types
- class st.matter.clusters.DoorLock.types.AlarmCodeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- LOCK_JAMMED: number
0
- LOCK_FACTORY_RESET: number
1
- LOCK_RADIO_POWER_CYCLED: number
3
- WRONG_CODE_ENTRY_LIMIT: number
4
- FRONT_ESCEUTCHEON_REMOVED: number
5
- DOOR_FORCED_OPEN: number
6
- DOOR_AJAR: number
7
- FORCED_USER: number
8
- class st.matter.clusters.DoorLock.types.CredentialRuleEnum: st.matter.data_types.Uint8
- byte_length: number
1
- SINGLE: number
0
- DUAL: number
1
- TRI: number
2
- class st.matter.clusters.DoorLock.types.CredentialTypeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- PROGRAMMINGPIN: number
0
- PIN: number
1
- RFID: number
2
- FINGERPRINT: number
3
- FINGER_VEIN: number
4
- FACE: number
5
- ALIRO_CREDENTIAL_ISSUER_KEY: number
6
- ALIRO_EVICTABLE_ENDPOINT_KEY: number
7
- ALIRO_NON_EVICTABLE_ENDPOINT_KEY: number
8
- class st.matter.clusters.DoorLock.types.DataOperationTypeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- ADD: number
0
- CLEAR: number
1
- MODIFY: number
2
- class st.matter.clusters.DoorLock.types.DlLockState: st.matter.data_types.Uint8
- byte_length: number
1
- NOT_FULLY_LOCKED: number
0
- LOCKED: number
1
- UNLOCKED: number
2
- UNLATCHED: number
3
- class st.matter.clusters.DoorLock.types.DlLockType: st.matter.data_types.Uint8
- byte_length: number
1
- 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
- EUROCYLINDER: number
11
- class st.matter.clusters.DoorLock.types.DlStatus: st.matter.data_types.Uint8
- byte_length: number
1
- SUCCESS: number
0
- FAILURE: number
1
- DUPLICATE: number
2
- OCCUPIED: number
3
- INVALID_FIELD: number
133
- RESOURCE_EXHAUSTED: number
137
- NOT_FOUND: number
139
- class st.matter.clusters.DoorLock.types.DoorLockOperationEventCode: st.matter.data_types.Uint8
- byte_length: number
1
- UNKNOWN_OR_MFG_SPECIFIC: number
0
- LOCK: number
1
- UNLOCK: number
2
- LOCK_INVALID_PIN_OR_ID: number
3
- LOCK_INVALID_SCHEDULE: number
4
- UNLOCK_INVALID_PIN_OR_ID: number
5
- UNLOCK_INVALID_SCHEDULE: number
6
- ONE_TOUCH_LOCK: number
7
- KEY_LOCK: number
8
- KEY_UNLOCK: number
9
- AUTO_LOCK: number
10
- SCHEDULE_LOCK: number
11
- SCHEDULE_UNLOCK: number
12
- MANUAL_LOCK: number
13
- MANUAL_UNLOCK: number
14
- class st.matter.clusters.DoorLock.types.DoorLockProgrammingEventCode: st.matter.data_types.Uint8
- byte_length: number
1
- UNKNOWN_OR_MFG_SPECIFIC: number
0
- MASTER_CODE_CHANGED: number
1
- PIN_ADDED: number
2
- PIN_DELETED: number
3
- PIN_CHANGED: number
4
- ID_ADDED: number
5
- ID_DELETED: number
6
- class st.matter.clusters.DoorLock.types.DoorLockSetPinOrIdStatus: st.matter.data_types.Uint8
- byte_length: number
1
- SUCCESS: number
0
- GENERAL_FAILURE: number
1
- MEMORY_FULL: number
2
- DUPLICATE_CODE_ERROR: number
3
- class st.matter.clusters.DoorLock.types.DoorLockUserStatus: st.matter.data_types.Uint8
- byte_length: number
1
- AVAILABLE: number
0
- OCCUPIED_ENABLED: number
1
- OCCUPIED_DISABLED: number
3
- NOT_SUPPORTED: number
255
- class st.matter.clusters.DoorLock.types.DoorLockUserType: st.matter.data_types.Uint8
- byte_length: number
1
- UNRESTRICTED: number
0
- YEAR_DAY_SCHEDULE_USER: number
1
- WEEK_DAY_SCHEDULE_USER: number
2
- MASTER_USER: number
3
- NON_ACCESS_USER: number
4
- NOT_SUPPORTED: number
255
- class st.matter.clusters.DoorLock.types.DoorStateEnum: st.matter.data_types.Uint8
- byte_length: number
1
- 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
- class st.matter.clusters.DoorLock.types.LockDataTypeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- UNSPECIFIED: number
0
- PROGRAMMING_CODE: number
1
- USER_INDEX: number
2
- WEEK_DAY_SCHEDULE: number
3
- YEAR_DAY_SCHEDULE: number
4
- HOLIDAY_SCHEDULE: number
5
- PIN: number
6
- RFID: number
7
- FINGERPRINT: number
8
- FINGER_VEIN: number
9
- FACE: number
10
- ALIRO_CREDENTIAL_ISSUER_KEY: number
11
- ALIRO_EVICTABLE_ENDPOINT_KEY: number
12
- ALIRO_NON_EVICTABLE_ENDPOINT_KEY: number
13
- class st.matter.clusters.DoorLock.types.LockOperationTypeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- LOCK: number
0
- UNLOCK: number
1
- NON_ACCESS_USER_EVENT: number
2
- FORCED_USER_EVENT: number
3
- UNLATCH: number
4
- class st.matter.clusters.DoorLock.types.OperatingModeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- NORMAL: number
0
- VACATION: number
1
- PRIVACY: number
2
- NO_REMOTE_LOCK_UNLOCK: number
3
- PASSAGE: number
4
- class st.matter.clusters.DoorLock.types.OperationErrorEnum: st.matter.data_types.Uint8
- byte_length: number
1
- UNSPECIFIED: number
0
- INVALID_CREDENTIAL: number
1
- DISABLED_USER_DENIED: number
2
- RESTRICTED: number
3
- INSUFFICIENT_BATTERY: number
4
- class st.matter.clusters.DoorLock.types.OperationSourceEnum: st.matter.data_types.Uint8
- byte_length: number
1
- UNSPECIFIED: number
0
- MANUAL: number
1
- PROPRIETARY_REMOTE: number
2
- KEYPAD: number
3
- AUTO: number
4
- BUTTON: number
5
- SCHEDULE: number
6
- REMOTE: number
7
- RFID: number
8
- BIOMETRIC: number
9
- ALIRO: number
10
- class st.matter.clusters.DoorLock.types.UserStatusEnum: st.matter.data_types.Uint8
- byte_length: number
1
- AVAILABLE: number
0
- OCCUPIED_ENABLED: number
1
- OCCUPIED_DISABLED: number
3
- class st.matter.clusters.DoorLock.types.UserTypeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- UNRESTRICTED_USER: number
0
- YEAR_DAY_SCHEDULE_USER: number
1
- WEEK_DAY_SCHEDULE_USER: number
2
- PROGRAMMING_USER: number
3
- NON_ACCESS_USER: number
4
- FORCED_USER: number
5
- DISPOSABLE_USER: number
6
- EXPIRING_USER: number
7
- SCHEDULE_RESTRICTED_USER: number
8
- REMOTE_ONLY_USER: number
9
Struct types
- class st.matter.clusters.DoorLock.types.CredentialStruct: st.matter.data_types.Structure
- credential_type: st.matter.generated.zap_clusters.DoorLock.types.CredentialTypeEnum
- credential_index: st.matter.data_types.Uint16