ElectricalEnergyMeasurement¶

Attributes¶

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.attributes.Accuracy¶

ID: number¶: 0x0000 the ID of this attribute

NAME: str¶: “Accuracy” the name of this attribute

data_type: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.MeasurementAccuracyStruct¶: the data type of this attribute

new_value(...)¶

Create a MeasurementAccuracyStruct 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 MeasurementAccuracyStruct
Return type:: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.MeasurementAccuracyStruct

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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 for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.attributes.CumulativeEnergyImported¶

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

NAME: str¶: “CumulativeEnergyImported” the name of this attribute

data_type: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the CumulativeEnergyImported(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a EnergyMeasurementStruct
Return type:: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: CumulativeEnergyImported => 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 CumulativeEnergyImported test attribute reponse for the driver integration testing framework

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.attributes.CumulativeEnergyExported¶

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

NAME: str¶: “CumulativeEnergyExported” the name of this attribute

data_type: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the CumulativeEnergyExported(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a EnergyMeasurementStruct
Return type:: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: CumulativeEnergyExported => 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 CumulativeEnergyExported test attribute reponse for the driver integration testing framework

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.attributes.PeriodicEnergyImported¶

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

NAME: str¶: “PeriodicEnergyImported” the name of this attribute

data_type: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the PeriodicEnergyImported(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a EnergyMeasurementStruct
Return type:: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: PeriodicEnergyImported => 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 PeriodicEnergyImported test attribute reponse for the driver integration testing framework

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.attributes.PeriodicEnergyExported¶

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

NAME: str¶: “PeriodicEnergyExported” the name of this attribute

data_type: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the PeriodicEnergyExported(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a EnergyMeasurementStruct
Return type:: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: PeriodicEnergyExported => 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 PeriodicEnergyExported test attribute reponse for the driver integration testing framework

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.attributes.CumulativeEnergyReset¶

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

NAME: str¶: “CumulativeEnergyReset” the name of this attribute

data_type: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.CumulativeEnergyResetStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the CumulativeEnergyReset(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a CumulativeEnergyResetStruct
Return type:: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.CumulativeEnergyResetStruct

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: CumulativeEnergyReset => 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 CumulativeEnergyReset test attribute reponse for the driver integration testing framework

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.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:: st.matter.data_types.Array

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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 for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.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:: st.matter.data_types.Array

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

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

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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 for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Events¶

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.events.CumulativeEnergyMeasured: st.matter.data_types.Structure ¶

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

NAME: str¶: “CumulativeEnergyMeasured” the name of this event

energy_imported: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶

energy_exported: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶

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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Constructs a subscribe InteractionRequest for the Event

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)¶

Builds an CumulativeEnergyMeasured test event report reponse to be used by

the driver integration testing framework.

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.server.events.PeriodicEnergyMeasured: st.matter.data_types.Structure ¶

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

NAME: str¶: “PeriodicEnergyMeasured” the name of this event

energy_imported: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶

energy_exported: st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct¶

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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Constructs a subscribe InteractionRequest for the Event

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)¶

Builds an PeriodicEnergyMeasured test event report reponse to be used by

the driver integration testing framework.

Parameters:

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

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Bitmap types¶

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.Feature¶

IMPORTED_ENERGY: number¶: 1

EXPORTED_ENERGY: number¶: 2

CUMULATIVE_ENERGY: number¶: 4

PERIODIC_ENERGY: number¶: 8

APPARENT_ENERGY: number¶: 16

REACTIVE_ENERGY: number¶: 32

is_imported_energy_set()¶

Returns:: True if the value of IMPORTED_ENERGY is non-zero
Return type:: boolean

set_imported_energy()¶: Set the value of the bit in the IMPORTED_ENERGY field to 1

unset_imported_energy()¶: Set the value of the bits in the IMPORTED_ENERGY field to 0

is_exported_energy_set()¶

Returns:: True if the value of EXPORTED_ENERGY is non-zero
Return type:: boolean

set_exported_energy()¶: Set the value of the bit in the EXPORTED_ENERGY field to 1

unset_exported_energy()¶: Set the value of the bits in the EXPORTED_ENERGY field to 0

is_cumulative_energy_set()¶

Returns:: True if the value of CUMULATIVE_ENERGY is non-zero
Return type:: boolean

set_cumulative_energy()¶: Set the value of the bit in the CUMULATIVE_ENERGY field to 1

unset_cumulative_energy()¶: Set the value of the bits in the CUMULATIVE_ENERGY field to 0

is_periodic_energy_set()¶

Returns:: True if the value of PERIODIC_ENERGY is non-zero
Return type:: boolean

set_periodic_energy()¶: Set the value of the bit in the PERIODIC_ENERGY field to 1

unset_periodic_energy()¶: Set the value of the bits in the PERIODIC_ENERGY field to 0

is_apparent_energy_set()¶

Returns:: True if the value of APPARENT_ENERGY is non-zero
Return type:: boolean

set_apparent_energy()¶: Set the value of the bit in the APPARENT_ENERGY field to 1

unset_apparent_energy()¶: Set the value of the bits in the APPARENT_ENERGY field to 0

is_reactive_energy_set()¶

Returns:: True if the value of REACTIVE_ENERGY is non-zero
Return type:: boolean

set_reactive_energy()¶: Set the value of the bit in the REACTIVE_ENERGY field to 1

unset_reactive_energy()¶: Set the value of the bits in the REACTIVE_ENERGY 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.ElectricalEnergyMeasurement.types.CumulativeEnergyResetStruct: st.matter.data_types.Structure ¶

imported_reset_timestamp: st.matter.data_types.Uint32¶

exported_reset_timestamp: st.matter.data_types.Uint32¶

imported_reset_systime: st.matter.data_types.Uint64¶

exported_reset_systime: st.matter.data_types.Uint64¶

class st.matter.generated.zap_clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct: st.matter.data_types.Structure ¶

energy: st.matter.data_types.Int64¶

start_timestamp: st.matter.data_types.Uint32¶

end_timestamp: st.matter.data_types.Uint32¶

start_systime: st.matter.data_types.Uint64¶

end_systime: st.matter.data_types.Uint64¶

apparent_energy: st.matter.data_types.Int64¶

reactive_energy: st.matter.data_types.Int64¶