MeterIdentification¶
- class st.zigbee.zcl.clusters.MeterIdentification¶
- ID: number¶
0x0B01 the ID of this cluster
- NAME: str¶
“MeterIdentification” the name of this cluster
- attributes: st.zigbee.zcl.clusters.MeterIdentificationServerAttributes or st.zigbee.zcl.clusters.MeterIdentificationClientAttributes¶
- commands: st.zigbee.zcl.clusters.MeterIdentificationServerCommands or st.zigbee.zcl.clusters.MeterIdentificationClientCommands¶
- types: st.zigbee.zcl.clusters.MeterIdentificationTypes¶
MeterIdentification Attributes¶
- class st.zigbee.zcl.clusters.MeterIdentification.CompanyName¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“CompanyName” the name of this attribute
- data_type: st.zigbee.data_types.CharString¶
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.CharString) – 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.CharString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a CharString object of this attribute with any additional features provided for the attribute
This is also usable with the CompanyName(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a CharString- 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.CharString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.MeterTypeID¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“MeterTypeID” the name of this attribute
- data_type: st.zigbee.data_types.Uint16¶
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.Uint16) – 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.Uint16) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the MeterTypeID(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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.Uint16) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.DataQualityID¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“DataQualityID” the name of this attribute
- data_type: st.zigbee.data_types.Uint16¶
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.Uint16) – 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.Uint16) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the DataQualityID(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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.Uint16) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.CustomerName¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“CustomerName” the name of this attribute
- data_type: st.zigbee.data_types.CharString¶
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.CharString) – 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.CharString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a CharString object of this attribute with any additional features provided for the attribute
This is also usable with the CustomerName(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a CharString- 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.CharString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- write(device, value)¶
Write a value to this attribute on a device
- Parameters:
device (
st.zigbee.Device)value (
st.zigbee.data_types.CharString) – the value to write
- class st.zigbee.zcl.clusters.MeterIdentification.Model¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“Model” the name of this attribute
- data_type: st.zigbee.data_types.OctetString¶
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.OctetString) – 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.OctetString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a OctetString object of this attribute with any additional features provided for the attribute
This is also usable with the Model(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OctetString- 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.OctetString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.PartNumber¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“PartNumber” the name of this attribute
- data_type: st.zigbee.data_types.OctetString¶
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.OctetString) – 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.OctetString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a OctetString 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 OctetString- 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.OctetString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.ProductRevision¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“ProductRevision” the name of this attribute
- data_type: st.zigbee.data_types.OctetString¶
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.OctetString) – 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.OctetString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a OctetString object of this attribute with any additional features provided for the attribute
This is also usable with the ProductRevision(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OctetString- 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.OctetString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.SoftwareRevision¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“SoftwareRevision” the name of this attribute
- data_type: st.zigbee.data_types.OctetString¶
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.OctetString) – 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.OctetString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a OctetString object of this attribute with any additional features provided for the attribute
This is also usable with the SoftwareRevision(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OctetString- 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.OctetString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.UtilityName¶
- ID: number¶
0x000B the ID of this attribute
- NAME: str¶
“UtilityName” the name of this attribute
- data_type: st.zigbee.data_types.CharString¶
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.CharString) – 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.CharString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a CharString object of this attribute with any additional features provided for the attribute
This is also usable with the UtilityName(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a CharString- 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.CharString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.POD¶
- ID: number¶
0x000C the ID of this attribute
- NAME: str¶
“POD” the name of this attribute
- data_type: st.zigbee.data_types.CharString¶
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.CharString) – 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.CharString) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a CharString object of this attribute with any additional features provided for the attribute
This is also usable with the POD(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a CharString- 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.CharString) – The amount of change of the attribute to trigger a report
- Returns:
containing a ConfigureReporting body
- Return type:
- class st.zigbee.zcl.clusters.MeterIdentification.AvailablePower¶
- ID: number¶
0x000D the ID of this attribute
- NAME: str¶
“AvailablePower” 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 AvailablePower(…) 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.MeterIdentification.PowerThreshold¶
- ID: number¶
0x000E the ID of this attribute
- NAME: str¶
“PowerThreshold” 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 PowerThreshold(…) 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: