BasicInformation
Attributes
- class st.matter.clusters.BasicInformation.DataModelRevision
- ID: number
0x0000 the ID of this attribute
- NAME: str
“DataModelRevision” 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 DataModelRevision(…) 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: DataModelRevision => 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 DataModelRevision 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.BasicInformation.VendorName
- ID: number
0x0001 the ID of this attribute
- NAME: str
“VendorName” 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 VendorName(…) 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
- subscribe(device, endpoint_id)
Reporting policy: VendorName => 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 VendorName 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.BasicInformation.VendorID
- ID: number
0x0002 the ID of this attribute
- NAME: str
“VendorID” 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 VendorID(…) 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: VendorID => 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 VendorID 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.BasicInformation.ProductName
- ID: number
0x0003 the ID of this attribute
- NAME: str
“ProductName” 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 ProductName(…) 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
- subscribe(device, endpoint_id)
Reporting policy: ProductName => 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 ProductName 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.BasicInformation.ProductID
- ID: number
0x0004 the ID of this attribute
- NAME: str
“ProductID” 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 ProductID(…) 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: ProductID => 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 ProductID 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.BasicInformation.NodeLabel
- ID: number
0x0005 the ID of this attribute
- NAME: str
“NodeLabel” 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 NodeLabel(…) 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: NodeLabel => 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 NodeLabel 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.BasicInformation.Location
- ID: number
0x0006 the ID of this attribute
- NAME: str
“Location” 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 Location(…) 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: Location => 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 Location 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.BasicInformation.HardwareVersion
- ID: number
0x0007 the ID of this attribute
- NAME: str
“HardwareVersion” 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 HardwareVersion(…) 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: HardwareVersion => 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 HardwareVersion 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.BasicInformation.HardwareVersionString
- ID: number
0x0008 the ID of this attribute
- NAME: str
“HardwareVersionString” 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 HardwareVersionString(…) 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
- subscribe(device, endpoint_id)
Reporting policy: HardwareVersionString => 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 HardwareVersionString 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.BasicInformation.SoftwareVersion
- ID: number
0x0009 the ID of this attribute
- NAME: str
“SoftwareVersion” 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 SoftwareVersion(…) 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
- subscribe(device, endpoint_id)
Reporting policy: SoftwareVersion => 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 SoftwareVersion 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.BasicInformation.SoftwareVersionString
- ID: number
0x000A the ID of this attribute
- NAME: str
“SoftwareVersionString” 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 SoftwareVersionString(…) 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
- subscribe(device, endpoint_id)
Reporting policy: SoftwareVersionString => 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 SoftwareVersionString 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.BasicInformation.ManufacturingDate
- ID: number
0x000B the ID of this attribute
- NAME: str
“ManufacturingDate” 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 ManufacturingDate(…) 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
- subscribe(device, endpoint_id)
Reporting policy: ManufacturingDate => 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 ManufacturingDate 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.BasicInformation.PartNumber
- ID: number
0x000C the ID of this attribute
- NAME: str
“PartNumber” 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 PartNumber(…) 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
- subscribe(device, endpoint_id)
Reporting policy: PartNumber => 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 PartNumber 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.BasicInformation.ProductURL
- ID: number
0x000D the ID of this attribute
- NAME: str
“ProductURL” the name of this attribute
- data_type: st.matter.data_types.UTF8String2
the data type of this attribute
- new_value(...)
Create a UTF8String2 object of this attribute with any additional features provided for the attribute
This is also usable with the ProductURL(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a UTF8String2- 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: ProductURL => 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 ProductURL 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.BasicInformation.ProductLabel
- ID: number
0x000E the ID of this attribute
- NAME: str
“ProductLabel” 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 ProductLabel(…) 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
- subscribe(device, endpoint_id)
Reporting policy: ProductLabel => 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 ProductLabel 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.BasicInformation.SerialNumber
- ID: number
0x000F the ID of this attribute
- NAME: str
“SerialNumber” 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 SerialNumber(…) 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
- subscribe(device, endpoint_id)
Reporting policy: SerialNumber => 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 SerialNumber 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.BasicInformation.LocalConfigDisabled
- ID: number
0x0010 the ID of this attribute
- NAME: str
“LocalConfigDisabled” 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 LocalConfigDisabled(…) 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: LocalConfigDisabled => 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 LocalConfigDisabled 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.BasicInformation.Reachable
- ID: number
0x0011 the ID of this attribute
- NAME: str
“Reachable” 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 Reachable(…) 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: Reachable => 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 Reachable 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.BasicInformation.UniqueID
- ID: number
0x0012 the ID of this attribute
- NAME: str
“UniqueID” 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 UniqueID(…) 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
- subscribe(device, endpoint_id)
Reporting policy: UniqueID => 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 UniqueID 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.BasicInformation.CapabilityMinima
- ID: number
0x0013 the ID of this attribute
- NAME: str
“CapabilityMinima” the name of this attribute
- data_type: st.matter.generated.zap_clusters.BasicInformation.types.CapabilityMinimaStruct
the data type of this attribute
- new_value(...)
Create a CapabilityMinimaStruct object of this attribute with any additional features provided for the attribute
This is also usable with the CapabilityMinima(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a CapabilityMinimaStruct- Return type
st.matter.generated.zap_clusters.BasicInformation.types.CapabilityMinimaStruct
- 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: CapabilityMinima => 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 CapabilityMinima 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.BasicInformation.ProductAppearance
- ID: number
0x0014 the ID of this attribute
- NAME: str
“ProductAppearance” the name of this attribute
- data_type: st.matter.generated.zap_clusters.BasicInformation.types.ProductAppearanceStruct
the data type of this attribute
- new_value(...)
Create a ProductAppearanceStruct object of this attribute with any additional features provided for the attribute
This is also usable with the ProductAppearance(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a ProductAppearanceStruct- Return type
st.matter.generated.zap_clusters.BasicInformation.types.ProductAppearanceStruct
- 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: ProductAppearance => 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 ProductAppearance 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.BasicInformation.SpecificationVersion
- ID: number
0x0015 the ID of this attribute
- NAME: str
“SpecificationVersion” 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 SpecificationVersion(…) 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
- subscribe(device, endpoint_id)
Reporting policy: SpecificationVersion => 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 SpecificationVersion 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.BasicInformation.MaxPathsPerInvoke
- ID: number
0x0016 the ID of this attribute
- NAME: str
“MaxPathsPerInvoke” 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 MaxPathsPerInvoke(…) 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: MaxPathsPerInvoke => 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 MaxPathsPerInvoke 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.BasicInformation.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.BasicInformation.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.BasicInformation.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) –
Server Commands
- class st.matter.clusters.BasicInformation.MfgSpecificPing
- ID: number
0x0000 the ID of this command
- NAME: str
“MfgSpecificPing” the name of this command
- build_test_command_response(device, endpoint_id, status)
Builds an MfgSpecificPing 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 MfgSpecificPing command
- Parameters
self (
MfgSpecificPing) – 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.BasicInformation.StartUp
- ID: number
0x0000 the ID of this event
- NAME: str
“StartUp” the name of this event
- software_version: st.matter.data_types.Uint32
- 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 StartUp 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.BasicInformation.ShutDown
- ID: number
0x0001 the ID of this event
- NAME: str
“ShutDown” the name of this event
- 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 ShutDown 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.BasicInformation.Leave
- ID: number
0x0002 the ID of this event
- NAME: str
“Leave” the name of this event
- fabric_index: st.matter.data_types.Uint8
- 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 Leave 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.BasicInformation.ReachableChanged
- ID: number
0x0003 the ID of this event
- NAME: str
“ReachableChanged” the name of this event
- reachable_new_value: st.matter.data_types.Boolean
- 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 ReachableChanged 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) –
Enum types
- class st.matter.clusters.BasicInformation.types.ColorEnum: st.matter.data_types.Uint8
- byte_length: number
1
- BLACK: number
0
- NAVY: number
1
- GREEN: number
2
- TEAL: number
3
- MAROON: number
4
- PURPLE: number
5
- OLIVE: number
6
- GRAY: number
7
- BLUE: number
8
- LIME: number
9
- AQUA: number
10
- RED: number
11
- FUCHSIA: number
12
- YELLOW: number
13
- WHITE: number
14
- NICKEL: number
15
- CHROME: number
16
- BRASS: number
17
- COPPER: number
18
- SILVER: number
19
- GOLD: number
20
Struct types
- class st.matter.clusters.BasicInformation.types.CapabilityMinimaStruct: st.matter.data_types.Structure
- case_sessions_per_fabric: st.matter.data_types.Uint16
- subscriptions_per_fabric: st.matter.data_types.Uint16
- class st.matter.clusters.BasicInformation.types.ProductAppearanceStruct: st.matter.data_types.Structure
- finish: st.matter.generated.zap_clusters.BasicInformation.types.ProductFinishEnum
- primary_color: st.matter.generated.zap_clusters.BasicInformation.types.ColorEnum