PowerSource

Attributes

class st.matter.clusters.PowerSource.Status
ID: number

0x0000 the ID of this attribute

NAME: str

“Status” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.PowerSourceStatusEnum

the data type of this attribute

new_value(...)

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

This is also usable with the Status(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.PowerSourceStatusEnum

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: Status => 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 Status 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.PowerSource.Order
ID: number

0x0001 the ID of this attribute

NAME: str

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

subscribe(device, endpoint_id)

Reporting policy: Order => 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 Order 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.PowerSource.Description
ID: number

0x0002 the ID of this attribute

NAME: str

“Description” the name of this attribute

data_type: st.matter.data_types.UTF8String1

the data type of this attribute

new_value(...)

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

This is also usable with the Description(…) syntax

Parameters

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

Return type

st.matter.data_types.UTF8String1

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: Description => 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 Description 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.PowerSource.WiredAssessedInputVoltage
ID: number

0x0003 the ID of this attribute

NAME: str

“WiredAssessedInputVoltage” 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 WiredAssessedInputVoltage(…) 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: WiredAssessedInputVoltage => 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 WiredAssessedInputVoltage 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.PowerSource.WiredAssessedInputFrequency
ID: number

0x0004 the ID of this attribute

NAME: str

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

subscribe(device, endpoint_id)

Reporting policy: WiredAssessedInputFrequency => 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 WiredAssessedInputFrequency 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.PowerSource.WiredCurrentType
ID: number

0x0005 the ID of this attribute

NAME: str

“WiredCurrentType” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.WiredCurrentTypeEnum

the data type of this attribute

new_value(...)

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

This is also usable with the WiredCurrentType(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.WiredCurrentTypeEnum

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: WiredCurrentType => 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 WiredCurrentType 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.PowerSource.WiredAssessedCurrent
ID: number

0x0006 the ID of this attribute

NAME: str

“WiredAssessedCurrent” 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 WiredAssessedCurrent(…) 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: WiredAssessedCurrent => 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 WiredAssessedCurrent 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.PowerSource.WiredNominalVoltage
ID: number

0x0007 the ID of this attribute

NAME: str

“WiredNominalVoltage” 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 WiredNominalVoltage(…) 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: WiredNominalVoltage => 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 WiredNominalVoltage 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.PowerSource.WiredMaximumCurrent
ID: number

0x0008 the ID of this attribute

NAME: str

“WiredMaximumCurrent” 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 WiredMaximumCurrent(…) 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: WiredMaximumCurrent => 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 WiredMaximumCurrent 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.PowerSource.WiredPresent
ID: number

0x0009 the ID of this attribute

NAME: str

“WiredPresent” 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 WiredPresent(…) 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: WiredPresent => 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 WiredPresent 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.PowerSource.ActiveWiredFaults
ID: number

0x000A the ID of this attribute

NAME: str

“ActiveWiredFaults” 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 ActiveWiredFaults(…) 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: ActiveWiredFaults => 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 ActiveWiredFaults 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.PowerSource.BatVoltage
ID: number

0x000B the ID of this attribute

NAME: str

“BatVoltage” 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 BatVoltage(…) 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: BatVoltage => 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 BatVoltage 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.PowerSource.BatPercentRemaining
ID: number

0x000C the ID of this attribute

NAME: str

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

subscribe(device, endpoint_id)

Reporting policy: BatPercentRemaining => 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 BatPercentRemaining 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.PowerSource.BatTimeRemaining
ID: number

0x000D the ID of this attribute

NAME: str

“BatTimeRemaining” 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 BatTimeRemaining(…) 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: BatTimeRemaining => 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 BatTimeRemaining 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.PowerSource.BatChargeLevel
ID: number

0x000E the ID of this attribute

NAME: str

“BatChargeLevel” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.BatChargeLevelEnum

the data type of this attribute

new_value(...)

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

This is also usable with the BatChargeLevel(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.BatChargeLevelEnum

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: BatChargeLevel => 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 BatChargeLevel 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.PowerSource.BatReplacementNeeded
ID: number

0x000F the ID of this attribute

NAME: str

“BatReplacementNeeded” 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 BatReplacementNeeded(…) 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: BatReplacementNeeded => 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 BatReplacementNeeded 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.PowerSource.BatReplaceability
ID: number

0x0010 the ID of this attribute

NAME: str

“BatReplaceability” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.BatReplaceabilityEnum

the data type of this attribute

new_value(...)

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

This is also usable with the BatReplaceability(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.BatReplaceabilityEnum

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: BatReplaceability => 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 BatReplaceability 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.PowerSource.BatPresent
ID: number

0x0011 the ID of this attribute

NAME: str

“BatPresent” 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 BatPresent(…) 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: BatPresent => 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 BatPresent 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.PowerSource.ActiveBatFaults
ID: number

0x0012 the ID of this attribute

NAME: str

“ActiveBatFaults” 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 ActiveBatFaults(…) 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: ActiveBatFaults => 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 ActiveBatFaults 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.PowerSource.BatReplacementDescription
ID: number

0x0013 the ID of this attribute

NAME: str

“BatReplacementDescription” the name of this attribute

data_type: st.matter.data_types.UTF8String1

the data type of this attribute

new_value(...)

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

This is also usable with the BatReplacementDescription(…) syntax

Parameters

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

Return type

st.matter.data_types.UTF8String1

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: BatReplacementDescription => 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 BatReplacementDescription 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.PowerSource.BatCommonDesignation
ID: number

0x0014 the ID of this attribute

NAME: str

“BatCommonDesignation” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.BatCommonDesignationEnum

the data type of this attribute

new_value(...)

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

This is also usable with the BatCommonDesignation(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.BatCommonDesignationEnum

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: BatCommonDesignation => 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 BatCommonDesignation 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.PowerSource.BatANSIDesignation
ID: number

0x0015 the ID of this attribute

NAME: str

“BatANSIDesignation” the name of this attribute

data_type: st.matter.data_types.UTF8String1

the data type of this attribute

new_value(...)

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

This is also usable with the BatANSIDesignation(…) syntax

Parameters

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

Return type

st.matter.data_types.UTF8String1

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: BatANSIDesignation => 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 BatANSIDesignation 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.PowerSource.BatIECDesignation
ID: number

0x0016 the ID of this attribute

NAME: str

“BatIECDesignation” the name of this attribute

data_type: st.matter.data_types.UTF8String1

the data type of this attribute

new_value(...)

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

This is also usable with the BatIECDesignation(…) syntax

Parameters

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

Return type

st.matter.data_types.UTF8String1

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: BatIECDesignation => 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 BatIECDesignation 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.PowerSource.BatApprovedChemistry
ID: number

0x0017 the ID of this attribute

NAME: str

“BatApprovedChemistry” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.BatApprovedChemistryEnum

the data type of this attribute

new_value(...)

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

This is also usable with the BatApprovedChemistry(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.BatApprovedChemistryEnum

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: BatApprovedChemistry => 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 BatApprovedChemistry 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.PowerSource.BatCapacity
ID: number

0x0018 the ID of this attribute

NAME: str

“BatCapacity” 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 BatCapacity(…) 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: BatCapacity => 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 BatCapacity 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.PowerSource.BatQuantity
ID: number

0x0019 the ID of this attribute

NAME: str

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

subscribe(device, endpoint_id)

Reporting policy: BatQuantity => 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 BatQuantity 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.PowerSource.BatChargeState
ID: number

0x001A the ID of this attribute

NAME: str

“BatChargeState” the name of this attribute

data_type: st.matter.generated.zap_clusters.PowerSource.types.BatChargeStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the BatChargeState(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.PowerSource.types.BatChargeStateEnum

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: BatChargeState => 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 BatChargeState 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.PowerSource.BatTimeToFullCharge
ID: number

0x001B the ID of this attribute

NAME: str

“BatTimeToFullCharge” 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 BatTimeToFullCharge(…) 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: BatTimeToFullCharge => 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 BatTimeToFullCharge 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.PowerSource.BatFunctionalWhileCharging
ID: number

0x001C the ID of this attribute

NAME: str

“BatFunctionalWhileCharging” 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 BatFunctionalWhileCharging(…) 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: BatFunctionalWhileCharging => 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 BatFunctionalWhileCharging 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.PowerSource.BatChargingCurrent
ID: number

0x001D the ID of this attribute

NAME: str

“BatChargingCurrent” 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 BatChargingCurrent(…) 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: BatChargingCurrent => 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 BatChargingCurrent 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.PowerSource.ActiveBatChargeFaults
ID: number

0x001E the ID of this attribute

NAME: str

“ActiveBatChargeFaults” 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 ActiveBatChargeFaults(…) 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: ActiveBatChargeFaults => 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 ActiveBatChargeFaults 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.PowerSource.EndpointList
ID: number

0x001F the ID of this attribute

NAME: str

“EndpointList” 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 EndpointList(…) 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: EndpointList => 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 EndpointList 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.PowerSource.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.PowerSource.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.PowerSource.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) –

Events

class st.matter.clusters.PowerSource.WiredFaultChange
ID: number

0x0000 the ID of this event

NAME: str

“WiredFaultChange” the name of this event

current: st.matter.data_types.Array
previous: st.matter.data_types.Array
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 WiredFaultChange 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.PowerSource.BatFaultChange
ID: number

0x0001 the ID of this event

NAME: str

“BatFaultChange” the name of this event

current: st.matter.data_types.Array
previous: st.matter.data_types.Array
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 BatFaultChange 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.PowerSource.BatChargeFaultChange
ID: number

0x0002 the ID of this event

NAME: str

“BatChargeFaultChange” the name of this event

current: st.matter.data_types.Array
previous: st.matter.data_types.Array
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 BatChargeFaultChange 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.PowerSource.types.Feature
WIRED: number

1

BATTERY: number

2

RECHARGEABLE: number

4

REPLACEABLE: number

8

is_wired_set()
Returns

True if the value of WIRED is non-zero

Return type

boolean

set_wired()

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

unset_wired()

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

is_battery_set()
Returns

True if the value of BATTERY is non-zero

Return type

boolean

set_battery()

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

unset_battery()

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

is_rechargeable_set()
Returns

True if the value of RECHARGEABLE is non-zero

Return type

boolean

set_rechargeable()

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

unset_rechargeable()

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

is_replaceable_set()
Returns

True if the value of REPLACEABLE is non-zero

Return type

boolean

set_replaceable()

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

unset_replaceable()

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

Enum types

class st.matter.clusters.PowerSource.types.BatApprovedChemistryEnum: st.matter.data_types.Uint16
byte_length: number

2

UNSPECIFIED: number

0

ALKALINE: number

1

LITHIUM_CARBON_FLUORIDE: number

2

LITHIUM_CHROMIUM_OXIDE: number

3

LITHIUM_COPPER_OXIDE: number

4

LITHIUM_IRON_DISULFIDE: number

5

LITHIUM_MANGANESE_DIOXIDE: number

6

LITHIUM_THIONYL_CHLORIDE: number

7

MAGNESIUM: number

8

MERCURY_OXIDE: number

9

NICKEL_OXYHYDRIDE: number

10

SILVER_OXIDE: number

11

ZINC_AIR: number

12

ZINC_CARBON: number

13

ZINC_CHLORIDE: number

14

ZINC_MANGANESE_DIOXIDE: number

15

LEAD_ACID: number

16

LITHIUM_COBALT_OXIDE: number

17

LITHIUM_ION: number

18

LITHIUM_ION_POLYMER: number

19

LITHIUM_IRON_PHOSPHATE: number

20

LITHIUM_SULFUR: number

21

LITHIUM_TITANATE: number

22

NICKEL_CADMIUM: number

23

NICKEL_HYDROGEN: number

24

NICKEL_IRON: number

25

NICKEL_METAL_HYDRIDE: number

26

NICKEL_ZINC: number

27

SILVER_ZINC: number

28

SODIUM_ION: number

29

SODIUM_SULFUR: number

30

ZINC_BROMIDE: number

31

ZINC_CERIUM: number

32

class st.matter.clusters.PowerSource.types.BatChargeFaultEnum: st.matter.data_types.Uint8
byte_length: number

1

UNSPECIFIED: number

0

AMBIENT_TOO_HOT: number

1

AMBIENT_TOO_COLD: number

2

BATTERY_TOO_HOT: number

3

BATTERY_TOO_COLD: number

4

BATTERY_ABSENT: number

5

BATTERY_OVER_VOLTAGE: number

6

BATTERY_UNDER_VOLTAGE: number

7

CHARGER_OVER_VOLTAGE: number

8

CHARGER_UNDER_VOLTAGE: number

9

SAFETY_TIMEOUT: number

10

class st.matter.clusters.PowerSource.types.BatChargeLevelEnum: st.matter.data_types.Uint8
byte_length: number

1

OK: number

0

WARNING: number

1

CRITICAL: number

2

class st.matter.clusters.PowerSource.types.BatChargeStateEnum: st.matter.data_types.Uint8
byte_length: number

1

UNKNOWN: number

0

IS_CHARGING: number

1

IS_AT_FULL_CHARGE: number

2

IS_NOT_CHARGING: number

3

class st.matter.clusters.PowerSource.types.BatCommonDesignationEnum: st.matter.data_types.Uint16
byte_length: number

2

UNSPECIFIED: number

0

AAA: number

1

AA: number

2

C: number

3

D: number

4

_4V5: number

5

_6V0: number

6

_9V0: number

7

_1_2AA: number

8

AAAA: number

9

A: number

10

B: number

11

F: number

12

N: number

13

NO6: number

14

SUBC: number

15

A23: number

16

A27: number

17

BA5800: number

18

DUPLEX: number

19

_4SR44: number

20

_523: number

21

_531: number

22

_15V0: number

23

_22V5: number

24

_30V0: number

25

_45V0: number

26

_67V5: number

27

J: number

28

CR123A: number

29

CR2: number

30

_2CR5: number

31

CR_P2: number

32

CR_V3: number

33

SR41: number

34

SR43: number

35

SR44: number

36

SR45: number

37

SR48: number

38

SR54: number

39

SR55: number

40

SR57: number

41

SR58: number

42

SR59: number

43

SR60: number

44

SR63: number

45

SR64: number

46

SR65: number

47

SR66: number

48

SR67: number

49

SR68: number

50

SR69: number

51

SR516: number

52

SR731: number

53

SR712: number

54

LR932: number

55

A5: number

56

A10: number

57

A13: number

58

A312: number

59

A675: number

60

AC41E: number

61

_10180: number

62

_10280: number

63

_10440: number

64

_14250: number

65

_14430: number

66

_14500: number

67

_14650: number

68

_15270: number

69

_16340: number

70

RCR123A: number

71

_17500: number

72

_17670: number

73

_18350: number

74

_18500: number

75

_18650: number

76

_19670: number

77

_25500: number

78

_26650: number

79

_32600: number

80

class st.matter.clusters.PowerSource.types.BatFaultEnum: st.matter.data_types.Uint8
byte_length: number

1

UNSPECIFIED: number

0

OVER_TEMP: number

1

UNDER_TEMP: number

2

class st.matter.clusters.PowerSource.types.BatReplaceabilityEnum: st.matter.data_types.Uint8
byte_length: number

1

UNSPECIFIED: number

0

NOT_REPLACEABLE: number

1

USER_REPLACEABLE: number

2

FACTORY_REPLACEABLE: number

3

class st.matter.clusters.PowerSource.types.PowerSourceStatusEnum: st.matter.data_types.Uint8
byte_length: number

1

UNSPECIFIED: number

0

ACTIVE: number

1

STANDBY: number

2

UNAVAILABLE: number

3

class st.matter.clusters.PowerSource.types.WiredCurrentTypeEnum: st.matter.data_types.Uint8
byte_length: number

1

AC: number

0

DC: number

1

class st.matter.clusters.PowerSource.types.WiredFaultEnum: st.matter.data_types.Uint8
byte_length: number

1

UNSPECIFIED: number

0

OVER_VOLTAGE: number

1

UNDER_VOLTAGE: number

2

Struct types

class st.matter.clusters.PowerSource.types.BatChargeFaultChangeType: st.matter.data_types.Structure
current: st.matter.data_types.Array
previous: st.matter.data_types.Array
class st.matter.clusters.PowerSource.types.BatFaultChangeType: st.matter.data_types.Structure
current: st.matter.data_types.Array
previous: st.matter.data_types.Array
class st.matter.clusters.PowerSource.types.WiredFaultChangeType: st.matter.data_types.Structure
current: st.matter.data_types.Array
previous: st.matter.data_types.Array