IASWD

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

0x0502 the ID of this cluster

NAME: str

“IASWD” the name of this cluster

attributes: st.zigbee.zcl.clusters.IASWDServerAttributes or st.zigbee.zcl.clusters.IASWDClientAttributes
commands: st.zigbee.zcl.clusters.IASWDServerCommands or st.zigbee.zcl.clusters.IASWDClientCommands
types: st.zigbee.zcl.clusters.IASWDTypes

IASWD Attributes

class st.zigbee.zcl.clusters.IASWD.MaxDuration
ID: number

0x0000 the ID of this attribute

NAME: str

“MaxDuration” 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 MaxDuration(…) 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:

IASWD Commands

class st.zigbee.zcl.clusters.IASWD.StartWarning
ID: number

0x00 the ID of this command

NAME: str

“StartWarning” the name of this command

siren_configuration: st.zigbee.zcl.clusters.IASWD.types.SirenConfiguration
warning_duration: st.zigbee.data_types.Uint16
strobe_duty_cycle: st.zigbee.data_types.Uint8
strobe_level: st.zigbee.zcl.clusters.IASWD.types.IaswdLevel
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

StartWarning

set_field_names()
static build_test_rx(device, siren_configuration, warning_duration, strobe_duty_cycle, strobe_level)

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, siren_configuration, warning_duration, strobe_duty_cycle, strobe_level)

Initialize the StartWarning command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.IASWD.Squawk
ID: number

0x01 the ID of this command

NAME: str

“Squawk” the name of this command

squawk_configuration: st.zigbee.zcl.clusters.IASWD.types.SquawkConfiguration
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

Squawk

set_field_names()
static build_test_rx(device, squawk_configuration)

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, squawk_configuration)

Initialize the Squawk command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

IASWD Types

class st.zigbee.zcl.clusters.IASWD.types.IaswdLevel: st.zigbee.data_types.Enum8
byte_length: number

1

LOW_LEVEL: number

0

MEDIUM_LEVEL: number

1

HIGH_LEVEL: number

2

VERY_HIGH_LEVEL: number

3

class st.zigbee.zcl.clusters.IASWD.types.SirenConfiguration: st.zigbee.data_types.Bitmap8
byte_length: number

1

SIREN_LEVEL: number

3

STROBE: number

12

WARNING_MODE: number

240

is_siren_level_set()
Returns:

True if the value of SIREN_LEVEL is non-zero

Return type:

boolean

set_siren_level(fieldVal)

Set the value of the bits in the SIREN_LEVEL field

Parameters:

fieldVal (number) – the value to set the bitfield to

get_siren_level()

Get the value of the bits in the SIREN_LEVEL field

unset_siren_level()

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

is_strobe_set()
Returns:

True if the value of STROBE is non-zero

Return type:

boolean

set_strobe(fieldVal)

Set the value of the bits in the STROBE field

Parameters:

fieldVal (number) – the value to set the bitfield to

get_strobe()

Get the value of the bits in the STROBE field

unset_strobe()

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

is_warning_mode_set()
Returns:

True if the value of WARNING_MODE is non-zero

Return type:

boolean

set_warning_mode(fieldVal)

Set the value of the bits in the WARNING_MODE field

Parameters:

fieldVal (number) – the value to set the bitfield to

get_warning_mode()

Get the value of the bits in the WARNING_MODE field

unset_warning_mode()

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

class st.zigbee.zcl.clusters.IASWD.types.Strobe: st.zigbee.data_types.Enum8
byte_length: number

1

NO_STROBE: number

0

USE_STROBE: number

1

class st.zigbee.zcl.clusters.IASWD.types.WarningMode: st.zigbee.data_types.Enum8
byte_length: number

1

STOP: number

0

BURGLAR: number

1

FIRE: number

2

EMERGENCY: number

3

POLICE_PANIC: number

4

FIRE_PANIC: number

5

EMERGENCY_PANIC: number

6

class st.zigbee.zcl.clusters.IASWD.types.SquawkConfiguration: st.zigbee.data_types.Bitmap8
byte_length: number

1

SQUAWK_LEVEL: number

3

SQUAWK_STROBE_ACTIVE: number

8

SQUAWK_MODE: number

240

is_squawk_level_set()
Returns:

True if the value of SQUAWK_LEVEL is non-zero

Return type:

boolean

set_squawk_level(fieldVal)

Set the value of the bits in the SQUAWK_LEVEL field

Parameters:

fieldVal (number) – the value to set the bitfield to

get_squawk_level()

Get the value of the bits in the SQUAWK_LEVEL field

unset_squawk_level()

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

is_squawk_strobe_active_set()
Returns:

True if the value of SQUAWK_STROBE_ACTIVE is non-zero

Return type:

boolean

set_squawk_strobe_active()

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

unset_squawk_strobe_active()

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

is_squawk_mode_set()
Returns:

True if the value of SQUAWK_MODE is non-zero

Return type:

boolean

set_squawk_mode(fieldVal)

Set the value of the bits in the SQUAWK_MODE field

Parameters:

fieldVal (number) – the value to set the bitfield to

get_squawk_mode()

Get the value of the bits in the SQUAWK_MODE field

unset_squawk_mode()

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

class st.zigbee.zcl.clusters.IASWD.types.SquawkMode: st.zigbee.data_types.Enum8
byte_length: number

1

SOUND_FOR_SYSTEM_IS_ARMED: number

0

SOUND_FOR_SYSTEM_IS_DISARMED: number

1