IlluminanceLevelSensing

class st.zigbee.zcl.clusters.IlluminanceLevelSensing

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

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

attributes: st.zigbee.zcl.clusters.IlluminanceLevelSensingServerAttributes or st.zigbee.zcl.clusters.IlluminanceLevelSensingClientAttributes

commands: st.zigbee.zcl.clusters.IlluminanceLevelSensingServerCommands or st.zigbee.zcl.clusters.IlluminanceLevelSensingClientCommands

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

IlluminanceLevelSensing Attributes

class st.zigbee.zcl.clusters.IlluminanceLevelSensing.LevelStatus

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

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

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

ILLUMINANCE_ON_TARGET: number: 0

ILLUMINANCE_BELOW_TARGET: number: 1

ILLUMINANCE_ABOVE_TARGET: number: 2

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 LevelStatus(…) 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) –

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

ID: number: 0x0001 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) –

class st.zigbee.zcl.clusters.IlluminanceLevelSensing.IlluminanceTargetLevel

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

NAME: str: “IlluminanceTargetLevel” 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 IlluminanceTargetLevel(…) 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

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Uint16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

IlluminanceLevelSensing

IlluminanceLevelSensing Attributes

IlluminanceLevelSensing Commands