BarrierControl

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

0x0103 the ID of this cluster

NAME: str

“BarrierControl” the name of this cluster

attributes: st.zigbee.zcl.clusters.BarrierControlServerAttributes or st.zigbee.zcl.clusters.BarrierControlClientAttributes
commands: st.zigbee.zcl.clusters.BarrierControlServerCommands or st.zigbee.zcl.clusters.BarrierControlClientCommands
types: st.zigbee.zcl.clusters.BarrierControlTypes

BarrierControl Attributes

class st.zigbee.zcl.clusters.BarrierControl.MovingState
ID: number

0x0001 the ID of this attribute

NAME: str

“MovingState” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

STOPPED: number

0

CLOSING: number

1

OPENING: 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
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 MovingState(…) 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.BarrierControl.SafetyStatus
ID: number

0x0002 the ID of this attribute

NAME: str

“SafetyStatus” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

REMOTE_LOCKOUT: number

1

TAMPER_DETECTED: number

2

FAILED_COMMUNICATION: number

4

POSITION_FAILURE: number

8

is_remote_lockout_set()
Returns

True if the value of REMOTE_LOCKOUT is non-zero

Return type

boolean

set_remote_lockout()

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

unset_remote_lockout()

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

is_tamper_detected_set()
Returns

True if the value of TAMPER_DETECTED is non-zero

Return type

boolean

set_tamper_detected()

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

unset_tamper_detected()

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

is_failed_communication_set()
Returns

True if the value of FAILED_COMMUNICATION is non-zero

Return type

boolean

set_failed_communication()

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

unset_failed_communication()

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

is_position_failure_set()
Returns

True if the value of POSITION_FAILURE is non-zero

Return type

boolean

set_position_failure()

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

unset_position_failure()

Set the value of the bits in the POSITION_FAILURE 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
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 Bitmap16 object of this attribute with any additional features provided for the attribute

This is also usable with the SafetyStatus(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Bitmap16

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.BarrierControl.Capabilities
ID: number

0x0003 the ID of this attribute

NAME: str

“Capabilities” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8

the data type of this attribute

PARTIAL_BARRIER: number

1

is_partial_barrier_set()
Returns

True if the value of PARTIAL_BARRIER is non-zero

Return type

boolean

set_partial_barrier()

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

unset_partial_barrier()

Set the value of the bits in the PARTIAL_BARRIER 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 Capabilities(…) 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

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.BarrierControl.OpenEvents
ID: number

0x0004 the ID of this attribute

NAME: str

“OpenEvents” 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 OpenEvents(…) 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.BarrierControl.CloseEvents
ID: number

0x0005 the ID of this attribute

NAME: str

“CloseEvents” 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 CloseEvents(…) 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.BarrierControl.CommandOpenEvents
ID: number

0x0006 the ID of this attribute

NAME: str

“CommandOpenEvents” 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 CommandOpenEvents(…) 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.BarrierControl.CommandCloseEvents
ID: number

0x0007 the ID of this attribute

NAME: str

“CommandCloseEvents” 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 CommandCloseEvents(…) 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.BarrierControl.OpenPeriod
ID: number

0x0008 the ID of this attribute

NAME: str

“OpenPeriod” 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 OpenPeriod(…) 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.BarrierControl.ClosePeriod
ID: number

0x0009 the ID of this attribute

NAME: str

“ClosePeriod” 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 ClosePeriod(…) 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.BarrierControl.BarrierPosition
ID: number

0x000A the ID of this attribute

NAME: str

“BarrierPosition” 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 BarrierPosition(…) 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) –

BarrierControl Commands

class st.zigbee.zcl.clusters.BarrierControl.GoToPercent
ID: number

0x00 the ID of this command

NAME: str

“GoToPercent” the name of this command

percent_open: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GoToPercent

set_field_names()
static build_test_rx(device, percent_open)

Build a version of this message as if it came from the device

Parameters
Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, percent_open)

Initialize the GoToPercent command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.BarrierControl.Stop
ID: number

0x01 the ID of this command

NAME: str

“Stop” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

Stop

set_field_names()
static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters

device (st.zigbee.Device) – the device to build the message from

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the Stop command

Parameters
  • self (Stop) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –