PumpConfigurationAndControl
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl
- ID: number
0x0200 the ID of this cluster
- NAME: str
“PumpConfigurationAndControl” the name of this cluster
- attributes: st.zigbee.zcl.clusters.PumpConfigurationAndControlServerAttributes or st.zigbee.zcl.clusters.PumpConfigurationAndControlClientAttributes
- commands: st.zigbee.zcl.clusters.PumpConfigurationAndControlServerCommands or st.zigbee.zcl.clusters.PumpConfigurationAndControlClientCommands
- types: st.zigbee.zcl.clusters.PumpConfigurationAndControlTypes
PumpConfigurationAndControl Attributes
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxPressure
- ID: number
0x0000 the ID of this attribute
- NAME: str
“MaxPressure” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxPressure(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxSpeed
- ID: number
0x0001 the ID of this attribute
- NAME: str
“MaxSpeed” 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 MaxSpeed(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxFlow
- ID: number
0x0002 the ID of this attribute
- NAME: str
“MaxFlow” 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 MaxFlow(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MinConstPressure
- ID: number
0x0003 the ID of this attribute
- NAME: str
“MinConstPressure” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinConstPressure(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxConstPressure
- ID: number
0x0004 the ID of this attribute
- NAME: str
“MaxConstPressure” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxConstPressure(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MinCompPressure
- ID: number
0x0005 the ID of this attribute
- NAME: str
“MinCompPressure” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinCompPressure(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxCompPressure
- ID: number
0x0006 the ID of this attribute
- NAME: str
“MaxCompPressure” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxCompPressure(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MinConstSpeed
- ID: number
0x0007 the ID of this attribute
- NAME: str
“MinConstSpeed” 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 MinConstSpeed(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxConstSpeed
- ID: number
0x0008 the ID of this attribute
- NAME: str
“MaxConstSpeed” 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 MaxConstSpeed(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MinConstFlow
- ID: number
0x0009 the ID of this attribute
- NAME: str
“MinConstFlow” 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 MinConstFlow(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxConstFlow
- ID: number
0x000A the ID of this attribute
- NAME: str
“MaxConstFlow” 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 MaxConstFlow(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MinConstTemp
- ID: number
0x000B the ID of this attribute
- NAME: str
“MinConstTemp” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinConstTemp(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.MaxConstTemp
- ID: number
0x000C the ID of this attribute
- NAME: str
“MaxConstTemp” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxConstTemp(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.PumpStatus
- ID: number
0x0010 the ID of this attribute
- NAME: str
“PumpStatus” the name of this attribute
- data_type: st.zigbee.data_types.Bitmap16
the data type of this attribute
- DEVICE_FAULT: number
1
- SUPPLY_FAULT: number
2
- SPEED_LOW: number
4
- SPEED_HIGH: number
8
- LOCAL_OVERRIDE: number
16
- RUNNING: number
32
- REMOTE_PRESSURE: number
64
- REMOTE_FLOW: number
128
- REMOTE_TEMPERATURE: number
256
- is_device_fault_set()
- Returns
True if the value of DEVICE_FAULT is non-zero
- Return type
boolean
- set_device_fault()
Set the value of the bit in the DEVICE_FAULT field to 1
- unset_device_fault()
Set the value of the bits in the DEVICE_FAULT field to 0
- is_supply_fault_set()
- Returns
True if the value of SUPPLY_FAULT is non-zero
- Return type
boolean
- set_supply_fault()
Set the value of the bit in the SUPPLY_FAULT field to 1
- unset_supply_fault()
Set the value of the bits in the SUPPLY_FAULT field to 0
- is_speed_low_set()
- Returns
True if the value of SPEED_LOW is non-zero
- Return type
boolean
- set_speed_low()
Set the value of the bit in the SPEED_LOW field to 1
- unset_speed_low()
Set the value of the bits in the SPEED_LOW field to 0
- is_speed_high_set()
- Returns
True if the value of SPEED_HIGH is non-zero
- Return type
boolean
- set_speed_high()
Set the value of the bit in the SPEED_HIGH field to 1
- unset_speed_high()
Set the value of the bits in the SPEED_HIGH field to 0
- is_local_override_set()
- Returns
True if the value of LOCAL_OVERRIDE is non-zero
- Return type
boolean
- set_local_override()
Set the value of the bit in the LOCAL_OVERRIDE field to 1
- unset_local_override()
Set the value of the bits in the LOCAL_OVERRIDE field to 0
- is_running_set()
- Returns
True if the value of RUNNING is non-zero
- Return type
boolean
- set_running()
Set the value of the bit in the RUNNING field to 1
- unset_running()
Set the value of the bits in the RUNNING field to 0
- is_remote_pressure_set()
- Returns
True if the value of REMOTE_PRESSURE is non-zero
- Return type
boolean
- set_remote_pressure()
Set the value of the bit in the REMOTE_PRESSURE field to 1
- unset_remote_pressure()
Set the value of the bits in the REMOTE_PRESSURE field to 0
- is_remote_flow_set()
- Returns
True if the value of REMOTE_FLOW is non-zero
- Return type
boolean
- set_remote_flow()
Set the value of the bit in the REMOTE_FLOW field to 1
- unset_remote_flow()
Set the value of the bits in the REMOTE_FLOW field to 0
- is_remote_temperature_set()
- Returns
True if the value of REMOTE_TEMPERATURE is non-zero
- Return type
boolean
- set_remote_temperature()
Set the value of the bit in the REMOTE_TEMPERATURE field to 1
- unset_remote_temperature()
Set the value of the bits in the REMOTE_TEMPERATURE field to 0
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.zigbee.data_types.Bitmap16
) – the base data type object to add functionality to
- 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.Bitmap16
) – 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.Bitmap16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Bitmap16 object of this attribute with any additional features provided for the attribute
This is also usable with the PumpStatus(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Bitmap16- 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)
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 attribute
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.EffectiveOperationMode
- ID: number
0x0011 the ID of this attribute
- NAME: str
“EffectiveOperationMode” the name of this attribute
- data_type: st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – 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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a PumpOperationModeType object of this attribute with any additional features provided for the attribute
This is also usable with the EffectiveOperationMode(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a PumpOperationModeType- Return type
st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
- 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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.EffectiveControlMode
- ID: number
0x0012 the ID of this attribute
- NAME: str
“EffectiveControlMode” the name of this attribute
- data_type: st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – 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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a PumpControlModeType object of this attribute with any additional features provided for the attribute
This is also usable with the EffectiveControlMode(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a PumpControlModeType- Return type
st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
- 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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.Capacity
- ID: number
0x0013 the ID of this attribute
- NAME: str
“Capacity” the name of this attribute
- data_type: st.zigbee.data_types.Int16
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.Int16
) – 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.Int16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the Capacity(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Int16- 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.Int16
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.Speed
- ID: number
0x0014 the ID of this attribute
- NAME: str
“Speed” 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 Speed(…) 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.LifetimeRunningHours
- ID: number
0x0015 the ID of this attribute
- NAME: str
“LifetimeRunningHours” the name of this attribute
- data_type: st.zigbee.data_types.Uint24
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.Uint24
) – 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.Uint24
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Uint24 object of this attribute with any additional features provided for the attribute
This is also usable with the LifetimeRunningHours(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint24- 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.Uint24
) – 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.Uint24
) – the value to write
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.Power
- ID: number
0x0016 the ID of this attribute
- NAME: str
“Power” the name of this attribute
- data_type: st.zigbee.data_types.Uint24
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.Uint24
) – 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.Uint24
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Uint24 object of this attribute with any additional features provided for the attribute
This is also usable with the Power(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint24- 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.Uint24
) – 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.Uint24
) – the value to write
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.LifetimeEnergyConsumed
- ID: number
0x0017 the ID of this attribute
- NAME: str
“LifetimeEnergyConsumed” the name of this attribute
- data_type: st.zigbee.data_types.Uint32
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.Uint32
) – 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.Uint32
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the LifetimeEnergyConsumed(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint32- 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.Uint32
) – The amount of change of the attribute to trigger a report
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.OperationMode
- ID: number
0x0020 the ID of this attribute
- NAME: str
“OperationMode” the name of this attribute
- data_type: st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – 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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a PumpOperationModeType object of this attribute with any additional features provided for the attribute
This is also usable with the OperationMode(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a PumpOperationModeType- Return type
st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
- 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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – 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.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
) – the value to write
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.ControlMode
- ID: number
0x0021 the ID of this attribute
- NAME: str
“ControlMode” the name of this attribute
- data_type: st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – 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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a PumpControlModeType object of this attribute with any additional features provided for the attribute
This is also usable with the ControlMode(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a PumpControlModeType- Return type
st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
- 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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – 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.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
) – the value to write
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.AlarmMask
- ID: number
0x0022 the ID of this attribute
- NAME: str
“AlarmMask” the name of this attribute
- data_type: st.zigbee.data_types.Bitmap16
the data type of this attribute
- SUPPLY_VOLTAGE_TOO_LOW: number
1
- SUPPLY_VOLTAGE_TOO_HIGH: number
2
- POWER_MISSING_PHASE: number
4
- SYSTEM_PRESSURE_TOO_LOW: number
8
- SYSTEM_PRESSURE_TOO_HIGH: number
16
- DRY_RUNNING: number
32
- MOTOR_TEMPERATURE_TOO_HIGH: number
64
- PUMP_MOTOR_HAS_FATAL_FAILURE: number
128
- ELECTRONIC_TEMPERATURE_TOO_HIGH: number
256
- PUMP_BLOCKED: number
512
- SENSOR_FAILURE: number
1024
- ELECTRONIC_NON_FATAL_FAILURE: number
2048
- ELECTRONIC_FATAL_FAILURE: number
4096
- GENERAL_FAULT: number
8192
- is_supply_voltage_too_low_set()
- Returns
True if the value of SUPPLY_VOLTAGE_TOO_LOW is non-zero
- Return type
boolean
- set_supply_voltage_too_low()
Set the value of the bit in the SUPPLY_VOLTAGE_TOO_LOW field to 1
- unset_supply_voltage_too_low()
Set the value of the bits in the SUPPLY_VOLTAGE_TOO_LOW field to 0
- is_supply_voltage_too_high_set()
- Returns
True if the value of SUPPLY_VOLTAGE_TOO_HIGH is non-zero
- Return type
boolean
- set_supply_voltage_too_high()
Set the value of the bit in the SUPPLY_VOLTAGE_TOO_HIGH field to 1
- unset_supply_voltage_too_high()
Set the value of the bits in the SUPPLY_VOLTAGE_TOO_HIGH field to 0
- is_power_missing_phase_set()
- Returns
True if the value of POWER_MISSING_PHASE is non-zero
- Return type
boolean
- set_power_missing_phase()
Set the value of the bit in the POWER_MISSING_PHASE field to 1
- unset_power_missing_phase()
Set the value of the bits in the POWER_MISSING_PHASE field to 0
- is_system_pressure_too_low_set()
- Returns
True if the value of SYSTEM_PRESSURE_TOO_LOW is non-zero
- Return type
boolean
- set_system_pressure_too_low()
Set the value of the bit in the SYSTEM_PRESSURE_TOO_LOW field to 1
- unset_system_pressure_too_low()
Set the value of the bits in the SYSTEM_PRESSURE_TOO_LOW field to 0
- is_system_pressure_too_high_set()
- Returns
True if the value of SYSTEM_PRESSURE_TOO_HIGH is non-zero
- Return type
boolean
- set_system_pressure_too_high()
Set the value of the bit in the SYSTEM_PRESSURE_TOO_HIGH field to 1
- unset_system_pressure_too_high()
Set the value of the bits in the SYSTEM_PRESSURE_TOO_HIGH field to 0
- is_dry_running_set()
- Returns
True if the value of DRY_RUNNING is non-zero
- Return type
boolean
- set_dry_running()
Set the value of the bit in the DRY_RUNNING field to 1
- unset_dry_running()
Set the value of the bits in the DRY_RUNNING field to 0
- is_motor_temperature_too_high_set()
- Returns
True if the value of MOTOR_TEMPERATURE_TOO_HIGH is non-zero
- Return type
boolean
- set_motor_temperature_too_high()
Set the value of the bit in the MOTOR_TEMPERATURE_TOO_HIGH field to 1
- unset_motor_temperature_too_high()
Set the value of the bits in the MOTOR_TEMPERATURE_TOO_HIGH field to 0
- is_pump_motor_has_fatal_failure_set()
- Returns
True if the value of PUMP_MOTOR_HAS_FATAL_FAILURE is non-zero
- Return type
boolean
- set_pump_motor_has_fatal_failure()
Set the value of the bit in the PUMP_MOTOR_HAS_FATAL_FAILURE field to 1
- unset_pump_motor_has_fatal_failure()
Set the value of the bits in the PUMP_MOTOR_HAS_FATAL_FAILURE field to 0
- is_electronic_temperature_too_high_set()
- Returns
True if the value of ELECTRONIC_TEMPERATURE_TOO_HIGH is non-zero
- Return type
boolean
- set_electronic_temperature_too_high()
Set the value of the bit in the ELECTRONIC_TEMPERATURE_TOO_HIGH field to 1
- unset_electronic_temperature_too_high()
Set the value of the bits in the ELECTRONIC_TEMPERATURE_TOO_HIGH field to 0
- is_pump_blocked_set()
- Returns
True if the value of PUMP_BLOCKED is non-zero
- Return type
boolean
- set_pump_blocked()
Set the value of the bit in the PUMP_BLOCKED field to 1
- unset_pump_blocked()
Set the value of the bits in the PUMP_BLOCKED field to 0
- is_sensor_failure_set()
- Returns
True if the value of SENSOR_FAILURE is non-zero
- Return type
boolean
- set_sensor_failure()
Set the value of the bit in the SENSOR_FAILURE field to 1
- unset_sensor_failure()
Set the value of the bits in the SENSOR_FAILURE field to 0
- is_electronic_non_fatal_failure_set()
- Returns
True if the value of ELECTRONIC_NON_FATAL_FAILURE is non-zero
- Return type
boolean
- set_electronic_non_fatal_failure()
Set the value of the bit in the ELECTRONIC_NON_FATAL_FAILURE field to 1
- unset_electronic_non_fatal_failure()
Set the value of the bits in the ELECTRONIC_NON_FATAL_FAILURE field to 0
- is_electronic_fatal_failure_set()
- Returns
True if the value of ELECTRONIC_FATAL_FAILURE is non-zero
- Return type
boolean
- set_electronic_fatal_failure()
Set the value of the bit in the ELECTRONIC_FATAL_FAILURE field to 1
- unset_electronic_fatal_failure()
Set the value of the bits in the ELECTRONIC_FATAL_FAILURE field to 0
- is_general_fault_set()
- Returns
True if the value of GENERAL_FAULT is non-zero
- Return type
boolean
- set_general_fault()
Set the value of the bit in the GENERAL_FAULT field to 1
- unset_general_fault()
Set the value of the bits in the GENERAL_FAULT field to 0
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.zigbee.data_types.Bitmap16
) – the base data type object to add functionality to
- 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.Bitmap16
) – 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.Bitmap16
) – the attribute value
- Returns
containing an ReadAttributeResponse body
- Return type
- new_value(...)
Create a Bitmap16 object of this attribute with any additional features provided for the attribute
This is also usable with the AlarmMask(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Bitmap16- 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)
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 attribute
- Returns
containing a ConfigureReporting body
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
PumpConfigurationAndControl Commands
PumpConfigurationAndControl Types
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpOperationMode
- NAME: PumpOperationMode
- get_length()
- Returns
the length in bytes of this frame
- Return type
number
- _serialize()
- Returns
this class serialized to bytes
- Return type
str
- pretty_print()
- Returns
this class in a human readable format
- Return type
str
- static deserialize(buf)
- Parameters
buf (
Reader
) – the buf to parse this class from- Returns
the length in bytes of this frame
- Return type
number
- static init()
- class st.zigbee.zcl.clusters.PumpConfigurationAndControl.types.PumpControlMode
- NAME: PumpControlMode
- get_length()
- Returns
the length in bytes of this frame
- Return type
number
- _serialize()
- Returns
this class serialized to bytes
- Return type
str
- pretty_print()
- Returns
this class in a human readable format
- Return type
str
- static deserialize(buf)
- Parameters
buf (
Reader
) – the buf to parse this class from- Returns
the length in bytes of this frame
- Return type
number
- static init()