ActivatedCarbonFilterMonitoring¶

Attributes¶

class st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.server.attributes.Condition¶

ID: number¶: 0x0000 the ID of this attribute

NAME: str¶: “Condition” 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 Condition(…) 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:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: Condition => 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 Condition 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.ActivatedCarbonFilterMonitoring.server.attributes.DegradationDirection¶

ID: number¶: 0x0001 the ID of this attribute

NAME: str¶: “DegradationDirection” the name of this attribute

data_type: st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.DegradationDirectionEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the DegradationDirection(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a DegradationDirectionEnum
Return type:: st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.DegradationDirectionEnum

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: DegradationDirection => 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 DegradationDirection 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.ActivatedCarbonFilterMonitoring.server.attributes.ChangeIndication¶

ID: number¶: 0x0002 the ID of this attribute

NAME: str¶: “ChangeIndication” the name of this attribute

data_type: st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.ChangeIndicationEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the ChangeIndication(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a ChangeIndicationEnum
Return type:: st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.ChangeIndicationEnum

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: ChangeIndication => 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 ChangeIndication 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.ActivatedCarbonFilterMonitoring.server.attributes.InPlaceIndicator¶

ID: number¶: 0x0003 the ID of this attribute

NAME: str¶: “InPlaceIndicator” 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 InPlaceIndicator(…) 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:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: InPlaceIndicator => 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 InPlaceIndicator 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.ActivatedCarbonFilterMonitoring.server.attributes.LastChangedTime¶

ID: number¶: 0x0004 the ID of this attribute

NAME: str¶: “LastChangedTime” 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 LastChangedTime(…) 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:

device (st.matter.Device)
endpoint_id (number or nil)

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

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: LastChangedTime => 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 LastChangedTime 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.ActivatedCarbonFilterMonitoring.server.attributes.ReplacementProductList¶

ID: number¶: 0x0005 the ID of this attribute

NAME: str¶: “ReplacementProductList” 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 ReplacementProductList(…) 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:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: ReplacementProductList => 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 ReplacementProductList 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.ActivatedCarbonFilterMonitoring.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:

device (st.matter.Device)
endpoint_id (number or nil)

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.ActivatedCarbonFilterMonitoring.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:

device (st.matter.Device)
endpoint_id (number or nil)

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)

Server Commands¶

class st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.server.commands.ResetCondition: st.matter.data_types.Structure ¶

ID: number¶: 0x0000 the ID of this command

NAME: str¶: “ResetCondition” the name of this command

build_test_command_response(device, endpoint_id, status)¶

Builds an ResetCondition 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(device)¶

Initialize the ResetCondition command

Parameters:: device (st.matter.Device) – the device to build this message to
Returns:: of type INVOKE
Return type:: st.matter.interaction_model.InteractionRequest

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)

Bitmap types¶

class st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.Feature¶

CONDITION: number¶: 1

WARNING: number¶: 2

REPLACEMENT_PRODUCT_LIST: number¶: 4

is_condition_set()¶

Returns:: True if the value of CONDITION is non-zero
Return type:: boolean

set_condition()¶: Set the value of the bit in the CONDITION field to 1

unset_condition()¶: Set the value of the bits in the CONDITION field to 0

is_warning_set()¶

Returns:: True if the value of WARNING is non-zero
Return type:: boolean

set_warning()¶: Set the value of the bit in the WARNING field to 1

unset_warning()¶: Set the value of the bits in the WARNING field to 0

is_replacement_product_list_set()¶

Returns:: True if the value of REPLACEMENT_PRODUCT_LIST is non-zero
Return type:: boolean

set_replacement_product_list()¶: Set the value of the bit in the REPLACEMENT_PRODUCT_LIST field to 1

unset_replacement_product_list()¶: Set the value of the bits in the REPLACEMENT_PRODUCT_LIST field to 0

Enum types¶

class st.matter.generated.zap_clusters.Global.types.ChangeIndicationEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

OK: number¶: 0

WARNING: number¶: 1

CRITICAL: number¶: 2

class st.matter.generated.zap_clusters.Global.types.DegradationDirectionEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

UP: number¶: 0

DOWN: number¶: 1

class st.matter.generated.zap_clusters.Global.types.ProductIdentifierTypeEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

UPC: number¶: 0

GTIN_8: number¶: 1

EAN: number¶: 2

GTIN_14: number¶: 3

OEM: number¶: 4

Struct types¶

class st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.ReplacementProductStruct: st.matter.data_types.Structure ¶

product_identifier_type: st.matter.generated.zap_clusters.ActivatedCarbonFilterMonitoring.types.ProductIdentifierTypeEnum¶

product_identifier_value: st.matter.data_types.UTF8String1¶