OccupancySensing

Attributes

class st.matter.clusters.OccupancySensing.Occupancy
ID: number

0x0000 the ID of this attribute

NAME: str

“Occupancy” the name of this attribute

data_type: st.matter.generated.zap_clusters.OccupancySensing.types.OccupancyBitmap

the data type of this attribute

new_value(...)

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

This is also usable with the Occupancy(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.OccupancySensing.types.OccupancyBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: Occupancy => true => suggested

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an Occupancy test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.OccupancySensorType
ID: number

0x0001 the ID of this attribute

NAME: str

“OccupancySensorType” the name of this attribute

data_type: st.matter.generated.zap_clusters.OccupancySensing.types.OccupancySensorTypeEnum

the data type of this attribute

new_value(...)

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

This is also usable with the OccupancySensorType(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.OccupancySensing.types.OccupancySensorTypeEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: OccupancySensorType => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an OccupancySensorType test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.OccupancySensorTypeBitmap
ID: number

0x0002 the ID of this attribute

NAME: str

“OccupancySensorTypeBitmap” the name of this attribute

data_type: st.matter.generated.zap_clusters.OccupancySensing.types.OccupancySensorTypeBitmap

the data type of this attribute

new_value(...)

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

This is also usable with the OccupancySensorTypeBitmap(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.OccupancySensing.types.OccupancySensorTypeBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: OccupancySensorTypeBitmap => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an OccupancySensorTypeBitmap test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.PIROccupiedToUnoccupiedDelay
ID: number

0x0010 the ID of this attribute

NAME: str

“PIROccupiedToUnoccupiedDelay” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the PIROccupiedToUnoccupiedDelay(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PIROccupiedToUnoccupiedDelay => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an PIROccupiedToUnoccupiedDelay test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.PIRUnoccupiedToOccupiedDelay
ID: number

0x0011 the ID of this attribute

NAME: str

“PIRUnoccupiedToOccupiedDelay” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the PIRUnoccupiedToOccupiedDelay(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PIRUnoccupiedToOccupiedDelay => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an PIRUnoccupiedToOccupiedDelay test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.PIRUnoccupiedToOccupiedThreshold
ID: number

0x0012 the ID of this attribute

NAME: str

“PIRUnoccupiedToOccupiedThreshold” the name of this attribute

data_type: st.matter.data_types.Uint8

the data type of this attribute

new_value(...)

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

This is also usable with the PIRUnoccupiedToOccupiedThreshold(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PIRUnoccupiedToOccupiedThreshold => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an PIRUnoccupiedToOccupiedThreshold test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.UltrasonicOccupiedToUnoccupiedDelay
ID: number

0x0020 the ID of this attribute

NAME: str

“UltrasonicOccupiedToUnoccupiedDelay” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the UltrasonicOccupiedToUnoccupiedDelay(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: UltrasonicOccupiedToUnoccupiedDelay => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an UltrasonicOccupiedToUnoccupiedDelay test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.UltrasonicUnoccupiedToOccupiedDelay
ID: number

0x0021 the ID of this attribute

NAME: str

“UltrasonicUnoccupiedToOccupiedDelay” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the UltrasonicUnoccupiedToOccupiedDelay(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: UltrasonicUnoccupiedToOccupiedDelay => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an UltrasonicUnoccupiedToOccupiedDelay test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.UltrasonicUnoccupiedToOccupiedThreshold
ID: number

0x0022 the ID of this attribute

NAME: str

“UltrasonicUnoccupiedToOccupiedThreshold” the name of this attribute

data_type: st.matter.data_types.Uint8

the data type of this attribute

new_value(...)

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

This is also usable with the UltrasonicUnoccupiedToOccupiedThreshold(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: UltrasonicUnoccupiedToOccupiedThreshold => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an UltrasonicUnoccupiedToOccupiedThreshold test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.PhysicalContactOccupiedToUnoccupiedDelay
ID: number

0x0030 the ID of this attribute

NAME: str

“PhysicalContactOccupiedToUnoccupiedDelay” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the PhysicalContactOccupiedToUnoccupiedDelay(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PhysicalContactOccupiedToUnoccupiedDelay => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an PhysicalContactOccupiedToUnoccupiedDelay test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.PhysicalContactUnoccupiedToOccupiedDelay
ID: number

0x0031 the ID of this attribute

NAME: str

“PhysicalContactUnoccupiedToOccupiedDelay” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the PhysicalContactUnoccupiedToOccupiedDelay(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PhysicalContactUnoccupiedToOccupiedDelay => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an PhysicalContactUnoccupiedToOccupiedDelay test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.PhysicalContactUnoccupiedToOccupiedThreshold
ID: number

0x0032 the ID of this attribute

NAME: str

“PhysicalContactUnoccupiedToOccupiedThreshold” the name of this attribute

data_type: st.matter.data_types.Uint8

the data type of this attribute

new_value(...)

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

This is also usable with the PhysicalContactUnoccupiedToOccupiedThreshold(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PhysicalContactUnoccupiedToOccupiedThreshold => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an PhysicalContactUnoccupiedToOccupiedThreshold test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.AcceptedCommandList
ID: number

0xFFF9 the ID of this attribute

NAME: str

“AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

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

This is also usable with the AcceptedCommandList(…) syntax

Parameters

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

Return type

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.EventList
ID: number

0xFFFA the ID of this attribute

NAME: str

“EventList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

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

This is also usable with the EventList(…) syntax

Parameters

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

Return type

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: EventList => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EventList test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

class st.matter.clusters.OccupancySensing.AttributeList
ID: number

0xFFFB the ID of this attribute

NAME: str

“AttributeList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

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

This is also usable with the AttributeList(…) syntax

Parameters

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

Return type

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)
Parameters

cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

  • value (any) –

  • status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

Bitmap types

class st.matter.clusters.OccupancySensing.types.OccupancyBitmap
OCCUPIED: number

1

is_occupied_set()
Returns

True if the value of OCCUPIED is non-zero

Return type

boolean

set_occupied()

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

unset_occupied()

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

class st.matter.clusters.OccupancySensing.types.OccupancySensorTypeBitmap
PIR: number

1

ULTRASONIC: number

2

PHYSICAL_CONTACT: number

4

is_pir_set()
Returns

True if the value of PIR is non-zero

Return type

boolean

set_pir()

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

unset_pir()

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

is_ultrasonic_set()
Returns

True if the value of ULTRASONIC is non-zero

Return type

boolean

set_ultrasonic()

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

unset_ultrasonic()

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

is_physical_contact_set()
Returns

True if the value of PHYSICAL_CONTACT is non-zero

Return type

boolean

set_physical_contact()

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

unset_physical_contact()

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

Enum types

class st.matter.clusters.OccupancySensing.types.OccupancySensorTypeEnum: st.matter.data_types.Uint8
byte_length: number

1

PIR: number

0

ULTRASONIC: number

1

PIR_AND_ULTRASONIC: number

2

PHYSICAL_CONTACT: number

3