ElectricalPowerMeasurement¶
Attributes¶
- class st.matter.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.PowerMode¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“PowerMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ElectricalPowerMeasurement.types.PowerModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a PowerModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the PowerMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a PowerModeEnum- Return type:
st.matter.generated.zap_clusters.ElectricalPowerMeasurement.types.PowerModeEnum
- 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: PowerMode => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an PowerMode 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.NumberOfMeasurementTypes¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“NumberOfMeasurementTypes” 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 NumberOfMeasurementTypes(…) 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: NumberOfMeasurementTypes => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an NumberOfMeasurementTypes 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.Accuracy¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“Accuracy” the name of this attribute
- data_type: st.matter.data_types.Array¶
the data type of this attribute
- augment_type(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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 Accuracy(…) 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: Accuracy => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an Accuracy 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.Ranges¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“Ranges” the name of this attribute
- data_type: st.matter.data_types.Array¶
the data type of this attribute
- augment_type(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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 Ranges(…) 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: Ranges => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an Ranges 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.Voltage¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“Voltage” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the Voltage(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: Voltage => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an Voltage 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.ActiveCurrent¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“ActiveCurrent” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the ActiveCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: ActiveCurrent => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an ActiveCurrent 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.ReactiveCurrent¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“ReactiveCurrent” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the ReactiveCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: ReactiveCurrent => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an ReactiveCurrent 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.ApparentCurrent¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“ApparentCurrent” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the ApparentCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: ApparentCurrent => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an ApparentCurrent 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.ActivePower¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“ActivePower” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the ActivePower(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: ActivePower => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an ActivePower 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.ReactivePower¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“ReactivePower” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the ReactivePower(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: ReactivePower => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an ReactivePower 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.ApparentPower¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“ApparentPower” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the ApparentPower(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: ApparentPower => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an ApparentPower 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.RMSVoltage¶
- ID: number¶
0x000B the ID of this attribute
- NAME: str¶
“RMSVoltage” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the RMSVoltage(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: RMSVoltage => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an RMSVoltage 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.RMSCurrent¶
- ID: number¶
0x000C the ID of this attribute
- NAME: str¶
“RMSCurrent” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the RMSCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: RMSCurrent => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an RMSCurrent 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.RMSPower¶
- ID: number¶
0x000D the ID of this attribute
- NAME: str¶
“RMSPower” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the RMSPower(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: RMSPower => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an RMSPower 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.Frequency¶
- ID: number¶
0x000E the ID of this attribute
- NAME: str¶
“Frequency” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the Frequency(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: Frequency => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an Frequency 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.HarmonicCurrents¶
- ID: number¶
0x000F the ID of this attribute
- NAME: str¶
“HarmonicCurrents” the name of this attribute
- data_type: st.matter.data_types.Array¶
the data type of this attribute
- augment_type(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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 HarmonicCurrents(…) 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: HarmonicCurrents => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an HarmonicCurrents 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.HarmonicPhases¶
- ID: number¶
0x0010 the ID of this attribute
- NAME: str¶
“HarmonicPhases” the name of this attribute
- data_type: st.matter.data_types.Array¶
the data type of this attribute
- augment_type(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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 HarmonicPhases(…) 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: HarmonicPhases => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an HarmonicPhases 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.PowerFactor¶
- ID: number¶
0x0011 the ID of this attribute
- NAME: str¶
“PowerFactor” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the PowerFactor(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: PowerFactor => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an PowerFactor 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.NeutralCurrent¶
- ID: number¶
0x0012 the ID of this attribute
- NAME: str¶
“NeutralCurrent” the name of this attribute
- data_type: st.matter.data_types.Int64¶
the data type of this attribute
- new_value(...)¶
Create a Int64 object of this attribute with any additional features provided for the attribute
This is also usable with the NeutralCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- 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: NeutralCurrent => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an NeutralCurrent 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.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(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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
- 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.generated.zap_clusters.ElectricalPowerMeasurement.server.attributes.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(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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
- 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)
Events¶
- class st.matter.generated.zap_clusters.ElectricalPowerMeasurement.server.events.MeasurementPeriodRanges: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this event
- NAME: str¶
“MeasurementPeriodRanges” the name of this event
- ranges: 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 MeasurementPeriodRanges 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)
Bitmap types¶
- class st.matter.generated.zap_clusters.ElectricalPowerMeasurement.types.Feature¶
- DIRECT_CURRENT: number¶
1
- ALTERNATING_CURRENT: number¶
2
- POLYPHASE_POWER: number¶
4
- HARMONICS: number¶
8
- POWER_QUALITY: number¶
16
- is_direct_current_set()¶
- Returns:
True if the value of DIRECT_CURRENT is non-zero
- Return type:
boolean
- set_direct_current()¶
Set the value of the bit in the DIRECT_CURRENT field to 1
- unset_direct_current()¶
Set the value of the bits in the DIRECT_CURRENT field to 0
- is_alternating_current_set()¶
- Returns:
True if the value of ALTERNATING_CURRENT is non-zero
- Return type:
boolean
- set_alternating_current()¶
Set the value of the bit in the ALTERNATING_CURRENT field to 1
- unset_alternating_current()¶
Set the value of the bits in the ALTERNATING_CURRENT field to 0
- is_polyphase_power_set()¶
- Returns:
True if the value of POLYPHASE_POWER is non-zero
- Return type:
boolean
- set_polyphase_power()¶
Set the value of the bit in the POLYPHASE_POWER field to 1
- unset_polyphase_power()¶
Set the value of the bits in the POLYPHASE_POWER field to 0
- is_harmonics_set()¶
- Returns:
True if the value of HARMONICS is non-zero
- Return type:
boolean
- set_harmonics()¶
Set the value of the bit in the HARMONICS field to 1
- unset_harmonics()¶
Set the value of the bits in the HARMONICS field to 0
- is_power_quality_set()¶
- Returns:
True if the value of POWER_QUALITY is non-zero
- Return type:
boolean
- set_power_quality()¶
Set the value of the bit in the POWER_QUALITY field to 1
- unset_power_quality()¶
Set the value of the bits in the POWER_QUALITY field to 0
Enum types¶
- class st.matter.generated.zap_clusters.Global.types.MeasurementTypeEnum: st.matter.data_types.Uint16¶
- byte_length: number¶
2
- UNSPECIFIED: number¶
0
- VOLTAGE: number¶
1
- ACTIVE_CURRENT: number¶
2
- REACTIVE_CURRENT: number¶
3
- APPARENT_CURRENT: number¶
4
- ACTIVE_POWER: number¶
5
- REACTIVE_POWER: number¶
6
- APPARENT_POWER: number¶
7
- RMS_VOLTAGE: number¶
8
- RMS_CURRENT: number¶
9
- RMS_POWER: number¶
10
- FREQUENCY: number¶
11
- POWER_FACTOR: number¶
12
- NEUTRAL_CURRENT: number¶
13
- ELECTRICAL_ENERGY: number¶
14
- REACTIVE_ENERGY: number¶
15
- APPARENT_ENERGY: number¶
16
- SOIL_MOISTURE: number¶
17
Struct types¶
- class st.matter.generated.zap_clusters.Global.types.MeasurementAccuracyRangeStruct: st.matter.data_types.Structure¶
- range_min: st.matter.data_types.Int64¶
- range_max: st.matter.data_types.Int64¶
- percent_max: st.matter.data_types.Uint16¶
- percent_min: st.matter.data_types.Uint16¶
- percent_typical: st.matter.data_types.Uint16¶
- fixed_max: st.matter.data_types.Uint64¶
- fixed_min: st.matter.data_types.Uint64¶
- fixed_typical: st.matter.data_types.Uint64¶
- class st.matter.generated.zap_clusters.Global.types.MeasurementAccuracyStruct: st.matter.data_types.Structure¶
- measurement_type: st.matter.generated.zap_clusters.Global.types.MeasurementTypeEnum¶
- measured: st.matter.data_types.Boolean¶
- min_measured_value: st.matter.data_types.Int64¶
- max_measured_value: st.matter.data_types.Int64¶
- accuracy_ranges: st.matter.data_types.Array¶
- class st.matter.generated.zap_clusters.ElectricalPowerMeasurement.types.HarmonicMeasurementStruct: st.matter.data_types.Structure¶
- order: st.matter.data_types.Uint8¶
- measurement: st.matter.data_types.Int64¶
- class st.matter.generated.zap_clusters.ElectricalPowerMeasurement.types.MeasurementRangeStruct: st.matter.data_types.Structure¶
- measurement_type: st.matter.generated.zap_clusters.ElectricalPowerMeasurement.types.MeasurementTypeEnum¶
- min: st.matter.data_types.Int64¶
- max: st.matter.data_types.Int64¶
- start_timestamp: st.matter.data_types.Uint32¶
- end_timestamp: st.matter.data_types.Uint32¶
- min_timestamp: st.matter.data_types.Uint32¶
- max_timestamp: st.matter.data_types.Uint32¶
- start_systime: st.matter.data_types.Uint64¶
- end_systime: st.matter.data_types.Uint64¶
- min_systime: st.matter.data_types.Uint64¶
- max_systime: st.matter.data_types.Uint64¶