IlluminanceMeasurement

class st.zigbee.zcl.clusters.IlluminanceMeasurement

ID: number: 0x0400 the ID of this cluster

NAME: str: “IlluminanceMeasurement” the name of this cluster

attributes: st.zigbee.zcl.clusters.IlluminanceMeasurementServerAttributes or st.zigbee.zcl.clusters.IlluminanceMeasurementClientAttributes

commands: st.zigbee.zcl.clusters.IlluminanceMeasurementServerCommands or st.zigbee.zcl.clusters.IlluminanceMeasurementClientCommands

types: st.zigbee.zcl.clusters.IlluminanceMeasurementTypes

IlluminanceMeasurement Attributes

class st.zigbee.zcl.clusters.IlluminanceMeasurement.MeasuredValue

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

NAME: str: “MeasuredValue” 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

st.zigbee.ZigbeeMessageRx

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

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the MeasuredValue(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint16
Return type: st.zigbee.data_types.Uint16

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: st.zigbee.ZigbeeMessageTx

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 attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IlluminanceMeasurement.MinMeasuredValue

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

NAME: str: “MinMeasuredValue” 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

st.zigbee.ZigbeeMessageRx

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

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the MinMeasuredValue(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint16
Return type: st.zigbee.data_types.Uint16

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: st.zigbee.ZigbeeMessageTx

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 attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IlluminanceMeasurement.MaxMeasuredValue

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

NAME: str: “MaxMeasuredValue” 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

st.zigbee.ZigbeeMessageRx

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

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the MaxMeasuredValue(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint16
Return type: st.zigbee.data_types.Uint16

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: st.zigbee.ZigbeeMessageTx

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 attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IlluminanceMeasurement.Tolerance

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

NAME: str: “Tolerance” 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

st.zigbee.ZigbeeMessageRx

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

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the Tolerance(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint16
Return type: st.zigbee.data_types.Uint16

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: st.zigbee.ZigbeeMessageTx

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 attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IlluminanceMeasurement.LightSensorType

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

NAME: str: “LightSensorType” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

PHOTODIODE: number: 0

CMOS: number: 1

UNKNOWN: number: 255

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.zigbee.data_types.Enum8) – 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.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

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

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the LightSensorType(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Enum8
Return type: st.zigbee.data_types.Enum8

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: st.zigbee.ZigbeeMessageTx

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 attribute
max_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

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

IlluminanceMeasurement

IlluminanceMeasurement Attributes

IlluminanceMeasurement Commands