IlluminanceMeasurement
Attributes
- class st.matter.clusters.IlluminanceMeasurement.MeasuredValue
- ID: number
0x0000 the ID of this attribute
- NAME: str
“MeasuredValue” 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 MeasuredValue(…) 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: MeasuredValue => 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 MeasuredValue 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.IlluminanceMeasurement.MinMeasuredValue
- ID: number
0x0001 the ID of this attribute
- NAME: str
“MinMeasuredValue” 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 MinMeasuredValue(…) 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: MinMeasuredValue => 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 MinMeasuredValue 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.IlluminanceMeasurement.MaxMeasuredValue
- ID: number
0x0002 the ID of this attribute
- NAME: str
“MaxMeasuredValue” 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 MaxMeasuredValue(…) 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: MaxMeasuredValue => 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 MaxMeasuredValue 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.IlluminanceMeasurement.Tolerance
- ID: number
0x0003 the ID of this attribute
- NAME: str
“Tolerance” 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 Tolerance(…) 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: Tolerance => 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 Tolerance 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.IlluminanceMeasurement.LightSensorType
- ID: number
0x0004 the ID of this attribute
- NAME: str
“LightSensorType” the name of this attribute
- data_type: st.matter.generated.zap_clusters.IlluminanceMeasurement.types.LightSensorTypeEnum
the data type of this attribute
- new_value(...)
Create a LightSensorTypeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the LightSensorType(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a LightSensorTypeEnum- Return type
st.matter.generated.zap_clusters.IlluminanceMeasurement.types.LightSensorTypeEnum
- 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: LightSensorType => 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 LightSensorType 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.IlluminanceMeasurement.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.IlluminanceMeasurement.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.IlluminanceMeasurement.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
) –
Enum types
- class st.matter.clusters.IlluminanceMeasurement.types.LightSensorTypeEnum: st.matter.data_types.Uint8
- byte_length: number
1
- PHOTODIODE: number
0
- CMOS: number
1