OccupancySensing

Attributes

class st.matter.generated.zap_clusters.OccupancySensing.server.attributes.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 => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.HoldTime
ID: number

0x0003 the ID of this attribute

NAME: str

“HoldTime” 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 HoldTime(…) 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: HoldTime => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an HoldTime 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.generated.zap_clusters.OccupancySensing.server.attributes.HoldTimeLimits
ID: number

0x0004 the ID of this attribute

NAME: str

“HoldTimeLimits” the name of this attribute

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

the data type of this attribute

new_value(...)

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

This is also usable with the HoldTimeLimits(…) syntax

Parameters:

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

Return type:

st.matter.generated.zap_clusters.OccupancySensing.types.HoldTimeLimitsStruct

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: HoldTimeLimits => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an HoldTimeLimits 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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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

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.generated.zap_clusters.OccupancySensing.server.attributes.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(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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

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.generated.zap_clusters.OccupancySensing.server.attributes.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(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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

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)

Events

class st.matter.generated.zap_clusters.OccupancySensing.server.events.OccupancyChanged: st.matter.data_types.Structure
ID: number

0x0000 the ID of this event

NAME: str

“OccupancyChanged” the name of this event

occupancy: st.matter.generated.zap_clusters.OccupancySensing.types.OccupancyBitmap
augment_type(base_type_obj)

Add field names to each event field

Parameters:

base_type_obj (st.matter.data_types.Structure)

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)

Builds an OccupancyChanged test event report reponse to be used by

the driver integration testing framework.

Parameters:

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

  • endpoint_id (number or nil)

  • fields (table) – containing the event fields

  • 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.generated.zap_clusters.OccupancySensing.types.Feature
OTHER: number

1

PASSIVE_INFRARED: number

2

ULTRASONIC: number

4

PHYSICAL_CONTACT: number

8

ACTIVE_INFRARED: number

16

RADAR: number

32

RF_SENSING: number

64

VISION: number

128

is_other_set()
Returns:

True if the value of OTHER is non-zero

Return type:

boolean

set_other()

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

unset_other()

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

is_passive_infrared_set()
Returns:

True if the value of PASSIVE_INFRARED is non-zero

Return type:

boolean

set_passive_infrared()

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

unset_passive_infrared()

Set the value of the bits in the PASSIVE_INFRARED 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

is_active_infrared_set()
Returns:

True if the value of ACTIVE_INFRARED is non-zero

Return type:

boolean

set_active_infrared()

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

unset_active_infrared()

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

is_radar_set()
Returns:

True if the value of RADAR is non-zero

Return type:

boolean

set_radar()

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

unset_radar()

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

is_rf_sensing_set()
Returns:

True if the value of RF_SENSING is non-zero

Return type:

boolean

set_rf_sensing()

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

unset_rf_sensing()

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

is_vision_set()
Returns:

True if the value of VISION is non-zero

Return type:

boolean

set_vision()

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

unset_vision()

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

class st.matter.generated.zap_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.generated.zap_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.generated.zap_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

Struct types

class st.matter.generated.zap_clusters.OccupancySensing.types.HoldTimeLimitsStruct: st.matter.data_types.Structure
hold_time_min: st.matter.data_types.Uint16
hold_time_max: st.matter.data_types.Uint16
hold_time_default: st.matter.data_types.Uint16