ShadeConfiguration

class st.zigbee.zcl.clusters.ShadeConfiguration
ID: number

0x0100 the ID of this cluster

NAME: str

“ShadeConfiguration” the name of this cluster

attributes: st.zigbee.zcl.clusters.ShadeConfigurationServerAttributes or st.zigbee.zcl.clusters.ShadeConfigurationClientAttributes
commands: st.zigbee.zcl.clusters.ShadeConfigurationServerCommands or st.zigbee.zcl.clusters.ShadeConfigurationClientCommands
types: st.zigbee.zcl.clusters.ShadeConfigurationTypes

ShadeConfiguration Attributes

class st.zigbee.zcl.clusters.ShadeConfiguration.PhysicalClosedLimit
ID: number

0x0000 the ID of this attribute

NAME: str

“PhysicalClosedLimit” 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
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
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 PhysicalClosedLimit(…) 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.ShadeConfiguration.MotorStepSize
ID: number

0x0001 the ID of this attribute

NAME: str

“MotorStepSize” the name of this attribute

data_type: st.zigbee.data_types.Uint8

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
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
Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the MotorStepSize(…) syntax

Parameters

vararg (vararg) – the values needed to construct a Uint8

Return type

st.zigbee.data_types.Uint8

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.Uint8) – 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.ShadeConfiguration.Status
ID: number

0x0002 the ID of this attribute

NAME: str

“Status” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8

the data type of this attribute

SHADE_OPERATIONAL: number

1

SHADE_ADJUSTING: number

2

SHADE_DIRECTION: number

4

FORWARD_DIRECTION_OF_MOTOR: number

8

is_shade_operational_set()
Returns

True if the value of SHADE_OPERATIONAL is non-zero

Return type

boolean

set_shade_operational()

Set the value of the bit in the SHADE_OPERATIONAL field to 1

unset_shade_operational()

Set the value of the bits in the SHADE_OPERATIONAL field to 0

is_shade_adjusting_set()
Returns

True if the value of SHADE_ADJUSTING is non-zero

Return type

boolean

set_shade_adjusting()

Set the value of the bit in the SHADE_ADJUSTING field to 1

unset_shade_adjusting()

Set the value of the bits in the SHADE_ADJUSTING field to 0

is_shade_direction_set()
Returns

True if the value of SHADE_DIRECTION is non-zero

Return type

boolean

set_shade_direction()

Set the value of the bit in the SHADE_DIRECTION field to 1

unset_shade_direction()

Set the value of the bits in the SHADE_DIRECTION field to 0

is_forward_direction_of_motor_set()
Returns

True if the value of FORWARD_DIRECTION_OF_MOTOR is non-zero

Return type

boolean

set_forward_direction_of_motor()

Set the value of the bit in the FORWARD_DIRECTION_OF_MOTOR field to 1

unset_forward_direction_of_motor()

Set the value of the bits in the FORWARD_DIRECTION_OF_MOTOR field to 0

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
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
Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the Status(…) syntax

Parameters

vararg (vararg) – the values needed to construct a Bitmap8

Return type

st.zigbee.data_types.Bitmap8

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

write(device, value)

Write a value to this attribute on a device

Parameters
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ShadeConfiguration.ClosedLimit
ID: number

0x0010 the ID of this attribute

NAME: str

“ClosedLimit” 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
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
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 ClosedLimit(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ShadeConfiguration.Mode
ID: number

0x0011 the ID of this attribute

NAME: str

“Mode” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

NORMAL: number

0

CONFIGURE: number

1

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
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
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 Mode(…) 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

write(device, value)

Write a value to this attribute on a device

Parameters
set_parent_cluster(cluster)
Parameters

cluster (any) –

ShadeConfiguration Commands

ShadeConfiguration Types

class st.zigbee.zcl.clusters.ShadeConfiguration.types.Direction: st.zigbee.data_types.Enum8
byte_length: number

1

CLOSING: number

0

OPENING: number

1