SimpleMetering¶
- class st.zigbee.zcl.clusters.SimpleMetering¶
- ID: number¶
0x0702 the ID of this cluster
- NAME: str¶
“SimpleMetering” the name of this cluster
- attributes: st.zigbee.zcl.clusters.SimpleMeteringServerAttributes or st.zigbee.zcl.clusters.SimpleMeteringClientAttributes¶
- commands: st.zigbee.zcl.clusters.SimpleMeteringServerCommands or st.zigbee.zcl.clusters.SimpleMeteringClientCommands¶
- types: st.zigbee.zcl.clusters.SimpleMeteringTypes¶
SimpleMetering Attributes¶
- class st.zigbee.zcl.clusters.SimpleMetering.CurrentSummationDelivered¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“CurrentSummationDelivered” the name of this attribute
- data_type: st.zigbee.data_types.Uint48¶
the data type of this attribute
- augment_type(base_type_obj)¶
- Parameters:
base_type_obj (
any)
- build_test_attr_report(device, data)¶
Build a Rx Zigbee message as if a device reported this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Uint48) – the attribute value
- Returns:
containing an AttributeReport body
- Return type:
- build_test_read_attr_response(device, data)¶
Build a Rx Zigbee message as if a device sent a read response for this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Uint48) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Uint48 object of this attribute with any additional features provided for the attribute
This is also usable with the CurrentSummationDelivered(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint48- Return type:
- read(device)¶
Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device
- Parameters:
device (
st.zigbee.Device)- Returns:
containing a ReadAttribute body
- Return type:
- configure_reporting(device, min_rep_int, max_rep_int, rep_change)¶
Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device
- Parameters:
device (
st.zigbee.Device)min_rep_int (
number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attributemax_rep_int (
number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attributerep_change (
st.zigbee.data_types.Uint48) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.SimpleMetering.InstantaneousDemand¶
- ID: number¶
0x0400 the ID of this attribute
- NAME: str¶
“InstantaneousDemand” the name of this attribute
- data_type: st.zigbee.data_types.Int24¶
the data type of this attribute
- augment_type(base_type_obj)¶
- Parameters:
base_type_obj (
any)
- build_test_attr_report(device, data)¶
Build a Rx Zigbee message as if a device reported this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Int24) – the attribute value
- Returns:
containing an AttributeReport body
- Return type:
- build_test_read_attr_response(device, data)¶
Build a Rx Zigbee message as if a device sent a read response for this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Int24) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Int24 object of this attribute with any additional features provided for the attribute
This is also usable with the InstantaneousDemand(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int24- Return type:
- read(device)¶
Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device
- Parameters:
device (
st.zigbee.Device)- Returns:
containing a ReadAttribute body
- Return type:
- configure_reporting(device, min_rep_int, max_rep_int, rep_change)¶
Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device
- Parameters:
device (
st.zigbee.Device)min_rep_int (
number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attributemax_rep_int (
number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attributerep_change (
st.zigbee.data_types.Int24) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.SimpleMetering.Multiplier¶
- ID: number¶
0x0301 the ID of this attribute
- NAME: str¶
“Multiplier” the name of this attribute
- data_type: st.zigbee.data_types.Int24¶
the data type of this attribute
- augment_type(base_type_obj)¶
- Parameters:
base_type_obj (
any)
- build_test_attr_report(device, data)¶
Build a Rx Zigbee message as if a device reported this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Int24) – the attribute value
- Returns:
containing an AttributeReport body
- Return type:
- build_test_read_attr_response(device, data)¶
Build a Rx Zigbee message as if a device sent a read response for this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Int24) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Int24 object of this attribute with any additional features provided for the attribute
This is also usable with the Multiplier(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int24- Return type:
- read(device)¶
Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device
- Parameters:
device (
st.zigbee.Device)- Returns:
containing a ReadAttribute body
- Return type:
- configure_reporting(device, min_rep_int, max_rep_int, rep_change)¶
Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device
- Parameters:
device (
st.zigbee.Device)min_rep_int (
number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attributemax_rep_int (
number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attributerep_change (
st.zigbee.data_types.Int24) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.SimpleMetering.Divisor¶
- ID: number¶
0x0302 the ID of this attribute
- NAME: str¶
“Divisor” the name of this attribute
- data_type: st.zigbee.data_types.Int24¶
the data type of this attribute
- augment_type(base_type_obj)¶
- Parameters:
base_type_obj (
any)
- build_test_attr_report(device, data)¶
Build a Rx Zigbee message as if a device reported this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Int24) – the attribute value
- Returns:
containing an AttributeReport body
- Return type:
- build_test_read_attr_response(device, data)¶
Build a Rx Zigbee message as if a device sent a read response for this attribute
- Parameters:
device (
st.zigbee.Device)data (
st.zigbee.data_types.Int24) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Int24 object of this attribute with any additional features provided for the attribute
This is also usable with the Divisor(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int24- Return type:
- read(device)¶
Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device
- Parameters:
device (
st.zigbee.Device)- Returns:
containing a ReadAttribute body
- Return type:
- configure_reporting(device, min_rep_int, max_rep_int, rep_change)¶
Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device
- Parameters:
device (
st.zigbee.Device)min_rep_int (
number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attributemax_rep_int (
number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attributerep_change (
st.zigbee.data_types.Int24) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type: