SmokeCoAlarm

Attributes

class st.matter.clusters.SmokeCoAlarm.ExpressedState
ID: number

0x0000 the ID of this attribute

NAME: str

“ExpressedState” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.ExpressedStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the ExpressedState(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.ExpressedStateEnum

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: ExpressedState => 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 ExpressedState 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.SmokeCoAlarm.SmokeState
ID: number

0x0001 the ID of this attribute

NAME: str

“SmokeState” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the SmokeState(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum

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: SmokeState => 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 SmokeState 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.SmokeCoAlarm.COState
ID: number

0x0002 the ID of this attribute

NAME: str

“COState” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the COState(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum

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: COState => 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 COState 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.SmokeCoAlarm.BatteryAlert
ID: number

0x0003 the ID of this attribute

NAME: str

“BatteryAlert” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the BatteryAlert(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum

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: BatteryAlert => 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 BatteryAlert 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.SmokeCoAlarm.DeviceMuted
ID: number

0x0004 the ID of this attribute

NAME: str

“DeviceMuted” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.MuteStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the DeviceMuted(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.MuteStateEnum

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: DeviceMuted => 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 DeviceMuted 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.SmokeCoAlarm.TestInProgress
ID: number

0x0005 the ID of this attribute

NAME: str

“TestInProgress” the name of this attribute

data_type: st.matter.data_types.Boolean

the data type of this attribute

new_value(...)

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

This is also usable with the TestInProgress(…) syntax

Parameters

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

Return type

st.matter.data_types.Boolean

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: TestInProgress => 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 TestInProgress 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.SmokeCoAlarm.HardwareFaultAlert
ID: number

0x0006 the ID of this attribute

NAME: str

“HardwareFaultAlert” the name of this attribute

data_type: st.matter.data_types.Boolean

the data type of this attribute

new_value(...)

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

This is also usable with the HardwareFaultAlert(…) syntax

Parameters

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

Return type

st.matter.data_types.Boolean

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: HardwareFaultAlert => 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 HardwareFaultAlert 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.SmokeCoAlarm.EndOfServiceAlert
ID: number

0x0007 the ID of this attribute

NAME: str

“EndOfServiceAlert” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.EndOfServiceEnum

the data type of this attribute

new_value(...)

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

This is also usable with the EndOfServiceAlert(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.EndOfServiceEnum

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: EndOfServiceAlert => 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 EndOfServiceAlert 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.SmokeCoAlarm.InterconnectSmokeAlarm
ID: number

0x0008 the ID of this event

NAME: str

“InterconnectSmokeAlarm” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 InterconnectSmokeAlarm 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.InterconnectCOAlarm
ID: number

0x0009 the ID of this event

NAME: str

“InterconnectCOAlarm” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 InterconnectCOAlarm 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.ContaminationState
ID: number

0x000A the ID of this attribute

NAME: str

“ContaminationState” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.ContaminationStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the ContaminationState(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.ContaminationStateEnum

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: ContaminationState => 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 ContaminationState 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.SmokeCoAlarm.SmokeSensitivityLevel
ID: number

0x000B the ID of this attribute

NAME: str

“SmokeSensitivityLevel” the name of this attribute

data_type: st.matter.generated.zap_clusters.SmokeCoAlarm.types.SensitivityEnum

the data type of this attribute

new_value(...)

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

This is also usable with the SmokeSensitivityLevel(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.SmokeCoAlarm.types.SensitivityEnum

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

  • device (st.matter.Device) –

  • endpoint_id (number or nil) –

  • value (st.matter.generated.zap_clusters.SmokeCoAlarm.types.SensitivityEnum) – the value to write

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SmokeSensitivityLevel => 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 SmokeSensitivityLevel 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.SmokeCoAlarm.ExpiryDate
ID: number

0x000C the ID of this attribute

NAME: str

“ExpiryDate” the name of this attribute

data_type: st.matter.data_types.Uint32

the data type of this attribute

new_value(...)

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

This is also usable with the ExpiryDate(…) syntax

Parameters

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

Return type

st.matter.data_types.Uint32

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: ExpiryDate => 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 ExpiryDate 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.SmokeCoAlarm.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.SmokeCoAlarm.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.SmokeCoAlarm.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) –

Server Commands

class st.matter.clusters.SmokeCoAlarm.SelfTestRequest
ID: number

0x0000 the ID of this command

NAME: str

“SelfTestRequest” the name of this command

build_test_command_response(device, endpoint_id, status)

Builds an SelfTestRequest test command reponse for the driver integration testing framework

Parameters

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

  • endpoint_id (number or nil) –

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

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device)

Initialize the SelfTestRequest command

Parameters

  • self (SelfTestRequest) – the template class for this command

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

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)
Parameters

cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters

base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

Events

class st.matter.clusters.SmokeCoAlarm.SmokeAlarm
ID: number

0x0000 the ID of this event

NAME: str

“SmokeAlarm” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 SmokeAlarm 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.COAlarm
ID: number

0x0001 the ID of this event

NAME: str

“COAlarm” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 COAlarm 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.LowBattery
ID: number

0x0002 the ID of this event

NAME: str

“LowBattery” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 LowBattery 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.HardwareFault
ID: number

0x0003 the ID of this event

NAME: str

“HardwareFault” the name of this event

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 HardwareFault 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.EndOfService
ID: number

0x0004 the ID of this event

NAME: str

“EndOfService” the name of this event

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 EndOfService 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.SelfTestComplete
ID: number

0x0005 the ID of this event

NAME: str

“SelfTestComplete” the name of this event

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 SelfTestComplete 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.AlarmMuted
ID: number

0x0006 the ID of this event

NAME: str

“AlarmMuted” the name of this event

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 AlarmMuted 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.MuteEnded
ID: number

0x0007 the ID of this event

NAME: str

“MuteEnded” the name of this event

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 MuteEnded 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.InterconnectSmokeAlarm
ID: number

0x0008 the ID of this event

NAME: str

“InterconnectSmokeAlarm” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 InterconnectSmokeAlarm 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.InterconnectCOAlarm
ID: number

0x0009 the ID of this event

NAME: str

“InterconnectCOAlarm” the name of this event

alarm_severity_level: st.matter.generated.zap_clusters.SmokeCoAlarm.types.AlarmStateEnum
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 InterconnectCOAlarm 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.matter.clusters.SmokeCoAlarm.AllClear
ID: number

0x000A the ID of this event

NAME: str

“AllClear” the name of this event

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 AllClear 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

Bitmap types

class st.matter.clusters.SmokeCoAlarm.types.Feature
SMOKE_ALARM: number

1

CO_ALARM: number

2

is_smoke_alarm_set()
Returns

True if the value of SMOKE_ALARM is non-zero

Return type

boolean

set_smoke_alarm()

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

unset_smoke_alarm()

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

is_co_alarm_set()
Returns

True if the value of CO_ALARM is non-zero

Return type

boolean

set_co_alarm()

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

unset_co_alarm()

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

Enum types

class st.matter.clusters.SmokeCoAlarm.types.AlarmStateEnum: st.matter.data_types.Uint8
byte_length: number

1

NORMAL: number

0

WARNING: number

1

CRITICAL: number

2

class st.matter.clusters.SmokeCoAlarm.types.ContaminationStateEnum: st.matter.data_types.Uint8
byte_length: number

1

NORMAL: number

0

LOW: number

1

WARNING: number

2

CRITICAL: number

3

class st.matter.clusters.SmokeCoAlarm.types.EndOfServiceEnum: st.matter.data_types.Uint8
byte_length: number

1

NORMAL: number

0

EXPIRED: number

1

class st.matter.clusters.SmokeCoAlarm.types.ExpressedStateEnum: st.matter.data_types.Uint8
byte_length: number

1

NORMAL: number

0

SMOKE_ALARM: number

1

CO_ALARM: number

2

BATTERY_ALERT: number

3

TESTING: number

4

HARDWARE_FAULT: number

5

END_OF_SERVICE: number

6

INTERCONNECT_SMOKE: number

7

INTERCONNECTCO: number

8

class st.matter.clusters.SmokeCoAlarm.types.MuteStateEnum: st.matter.data_types.Uint8
byte_length: number

1

NOT_MUTED: number

0

MUTED: number

1

class st.matter.clusters.SmokeCoAlarm.types.SensitivityEnum: st.matter.data_types.Uint8
byte_length: number

1

HIGH: number

0

STANDARD: number

1

LOW: number

2