AnalogInput¶
- class st.zigbee.zcl.clusters.AnalogInput¶
- ID: number¶
0x000C the ID of this cluster
- NAME: str¶
“AnalogInput” the name of this cluster
- attributes: st.zigbee.zcl.clusters.AnalogInputServerAttributes or st.zigbee.zcl.clusters.AnalogInputClientAttributes¶
- commands: st.zigbee.zcl.clusters.AnalogInputServerCommands or st.zigbee.zcl.clusters.AnalogInputClientCommands¶
- types: st.zigbee.zcl.clusters.AnalogInputTypes¶
AnalogInput Attributes¶
- class st.zigbee.zcl.clusters.AnalogInput.Description¶
- ID: number¶
0x001C the ID of this attribute
- NAME: str¶
“Description” 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 Description(…) 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.AnalogInput.MaxPresentValue¶
- ID: number¶
0x0041 the ID of this attribute
- NAME: str¶
“MaxPresentValue” the name of this attribute
- data_type: st.zigbee.data_types.SinglePrecisionFloat¶
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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the MaxPresentValue(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SinglePrecisionFloat- 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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.MinPresentValue¶
- ID: number¶
0x0045 the ID of this attribute
- NAME: str¶
“MinPresentValue” the name of this attribute
- data_type: st.zigbee.data_types.SinglePrecisionFloat¶
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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the MinPresentValue(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SinglePrecisionFloat- 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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.OutOfService¶
- ID: number¶
0x0051 the ID of this attribute
- NAME: str¶
“OutOfService” the name of this attribute
- data_type: st.zigbee.data_types.Boolean¶
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.Boolean) – 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.Boolean) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the OutOfService(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- 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:
- write(device, value)¶
Write a value to this attribute on a device
- Parameters:
device (
st.zigbee.Device)value (
st.zigbee.data_types.Boolean) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.PresentValue¶
- ID: number¶
0x0055 the ID of this attribute
- NAME: str¶
“PresentValue” the name of this attribute
- data_type: st.zigbee.data_types.SinglePrecisionFloat¶
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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the PresentValue(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SinglePrecisionFloat- 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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.Reliability¶
- ID: number¶
0x0067 the ID of this attribute
- NAME: str¶
“Reliability” the name of this attribute
- data_type: st.zigbee.data_types.Enum8¶
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.Enum8) – 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.Enum8) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Enum8 object of this attribute with any additional features provided for the attribute
This is also usable with the Reliability(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Enum8- 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:
- write(device, value)¶
Write a value to this attribute on a device
- Parameters:
device (
st.zigbee.Device)value (
st.zigbee.data_types.Enum8) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.Resolution¶
- ID: number¶
0x006A the ID of this attribute
- NAME: str¶
“Resolution” the name of this attribute
- data_type: st.zigbee.data_types.SinglePrecisionFloat¶
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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the Resolution(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SinglePrecisionFloat- 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.SinglePrecisionFloat) – 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.SinglePrecisionFloat) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.StatusFlags¶
- ID: number¶
0x006F the ID of this attribute
- NAME: str¶
“StatusFlags” the name of this attribute
- data_type: st.zigbee.data_types.Bitmap8¶
the data type of this attribute
- augment_type(base_type_obj)¶
Add additional functionality to the base type object
- Parameters:
base_type_obj (
st.zigbee.data_types.Bitmap8) – 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.Bitmap8) – 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.Bitmap8) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Bitmap8 object of this attribute with any additional features provided for the attribute
This is also usable with the StatusFlags(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Bitmap8- 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:
- class st.zigbee.zcl.clusters.AnalogInput.EngineeringUnits¶
- ID: number¶
0x0075 the ID of this attribute
- NAME: str¶
“EngineeringUnits” the name of this attribute
- data_type: st.zigbee.data_types.Enum16¶
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.Enum16) – 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.Enum16) – the attribute value
- Returns:
containing an ReadAttributeResponse body
- Return type:
- new_value(...)¶
Create a Enum16 object of this attribute with any additional features provided for the attribute
This is also usable with the EngineeringUnits(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Enum16- 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:
- write(device, value)¶
Write a value to this attribute on a device
- Parameters:
device (
st.zigbee.Device)value (
st.zigbee.data_types.Enum16) – the value to write
- class st.zigbee.zcl.clusters.AnalogInput.ApplicationType¶
- ID: number¶
0x0100 the ID of this attribute
- NAME: str¶
“ApplicationType” 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 ApplicationType(…) 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: