Time

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

0x000A the ID of this cluster

NAME: str

“Time” the name of this cluster

attributes: st.zigbee.zcl.clusters.TimeServerAttributes or st.zigbee.zcl.clusters.TimeClientAttributes
commands: st.zigbee.zcl.clusters.TimeServerCommands or st.zigbee.zcl.clusters.TimeClientCommands
types: st.zigbee.zcl.clusters.TimeTypes

Time Attributes

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

0x0000 the ID of this attribute

NAME: str

“Time” the name of this attribute

data_type: st.zigbee.data_types.UtcTime

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.UtcTime) – 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.UtcTime) – the attribute value

Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the Time(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.UtcTime

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.UtcTime) – 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.UtcTime) – the value to write

class st.zigbee.zcl.clusters.Time.TimeStatus
ID: number

0x0001 the ID of this attribute

NAME: str

“TimeStatus” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8

the data type of this attribute

MASTER: number

1

SYNCHRONIZED: number

2

MASTER_ZONE_DST: number

4

SUPERSEDING: number

8

is_master_set()
Returns:

True if the value of MASTER is non-zero

Return type:

boolean

set_master()

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

unset_master()

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

is_synchronized_set()
Returns:

True if the value of SYNCHRONIZED is non-zero

Return type:

boolean

set_synchronized()

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

unset_synchronized()

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

is_master_zone_dst_set()
Returns:

True if the value of MASTER_ZONE_DST is non-zero

Return type:

boolean

set_master_zone_dst()

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

unset_master_zone_dst()

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

is_superseding_set()
Returns:

True if the value of SUPERSEDING is non-zero

Return type:

boolean

set_superseding()

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

unset_superseding()

Set the value of the bits in the SUPERSEDING 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 TimeStatus(…) 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:
class st.zigbee.zcl.clusters.Time.TimeZone
ID: number

0x0002 the ID of this attribute

NAME: str

“TimeZone” the name of this attribute

data_type: st.zigbee.data_types.Int32

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 Int32 object of this attribute with any additional features provided for the attribute

This is also usable with the TimeZone(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Int32

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.Int32) – 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:
class st.zigbee.zcl.clusters.Time.DstStart
ID: number

0x0003 the ID of this attribute

NAME: str

“DstStart” 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:
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 Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the DstStart(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Uint32

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.Uint32) – 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:
class st.zigbee.zcl.clusters.Time.DstEnd
ID: number

0x0004 the ID of this attribute

NAME: str

“DstEnd” 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:
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 Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the DstEnd(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Uint32

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.Uint32) – 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:
class st.zigbee.zcl.clusters.Time.DstShift
ID: number

0x0005 the ID of this attribute

NAME: str

“DstShift” the name of this attribute

data_type: st.zigbee.data_types.Int32

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 Int32 object of this attribute with any additional features provided for the attribute

This is also usable with the DstShift(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Int32

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.Int32) – 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:
class st.zigbee.zcl.clusters.Time.StandardTime
ID: number

0x0006 the ID of this attribute

NAME: str

“StandardTime” 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:
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 Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the StandardTime(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Uint32

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.Uint32) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Time.LocalTime
ID: number

0x0007 the ID of this attribute

NAME: str

“LocalTime” 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:
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 Uint32 object of this attribute with any additional features provided for the attribute

This is also usable with the LocalTime(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Uint32

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.Uint32) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Time.LastSetTime
ID: number

0x0008 the ID of this attribute

NAME: str

“LastSetTime” the name of this attribute

data_type: st.zigbee.data_types.UtcTime

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.UtcTime) – 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.UtcTime) – the attribute value

Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the LastSetTime(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.UtcTime

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.UtcTime) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Time.ValidUntilTime
ID: number

0x0009 the ID of this attribute

NAME: str

“ValidUntilTime” the name of this attribute

data_type: st.zigbee.data_types.UtcTime

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.UtcTime) – 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.UtcTime) – the attribute value

Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ValidUntilTime(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.UtcTime

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.UtcTime) – 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.UtcTime) – the value to write

Time Commands