DeviceEnergyManagement¶

Attributes¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.attributes.ESAType¶

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

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

data_type: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ESATypeEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the ESAType(…) syntax

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

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: ESAType => 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 ESAType 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.DeviceEnergyManagement.server.attributes.ESACanGenerate¶

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

NAME: str¶: “ESACanGenerate” 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 ESACanGenerate(…) 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: ESACanGenerate => 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 ESACanGenerate 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.DeviceEnergyManagement.server.attributes.ESAState¶

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

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

data_type: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ESAStateEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the ESAState(…) syntax

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

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: ESAState => 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 ESAState 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.DeviceEnergyManagement.server.attributes.AbsMinPower¶

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

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

data_type: st.matter.data_types.Int64¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the AbsMinPower(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Int64
Return type:: st.matter.data_types.Int64

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: AbsMinPower => 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 AbsMinPower 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.DeviceEnergyManagement.server.attributes.AbsMaxPower¶

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

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

data_type: st.matter.data_types.Int64¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the AbsMaxPower(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Int64
Return type:: st.matter.data_types.Int64

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: AbsMaxPower => 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 AbsMaxPower 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.DeviceEnergyManagement.server.attributes.PowerAdjustmentCapability¶

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

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

data_type: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.PowerAdjustCapabilityStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the PowerAdjustmentCapability(…) syntax

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

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: PowerAdjustmentCapability => 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 PowerAdjustmentCapability 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.DeviceEnergyManagement.server.attributes.Forecast¶

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

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

data_type: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ForecastStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the Forecast(…) syntax

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

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: Forecast => 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 Forecast 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.DeviceEnergyManagement.server.attributes.OptOutState¶

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

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

data_type: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.OptOutStateEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the OptOutState(…) syntax

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

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: OptOutState => 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 OptOutState 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.DeviceEnergyManagement.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.DeviceEnergyManagement.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.DeviceEnergyManagement.server.commands.PowerAdjustRequest: st.matter.data_types.Structure ¶

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

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

power: st.matter.data_types.Int64¶

duration: st.matter.data_types.Uint32¶

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum¶

build_test_command_response(device, endpoint_id, status)¶

Builds an PowerAdjustRequest 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, power, duration, cause)¶

Initialize the PowerAdjustRequest command

Parameters:

device (st.matter.Device) – the device to build this message to
power (st.matter.data_types.Int64)
duration (st.matter.data_types.Uint32)
cause (st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum)

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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.CancelPowerAdjustRequest: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an CancelPowerAdjustRequest 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 CancelPowerAdjustRequest 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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.StartTimeAdjustRequest: st.matter.data_types.Structure ¶

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

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

requested_start_time: st.matter.data_types.Uint32¶

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum¶

build_test_command_response(device, endpoint_id, status)¶

Builds an StartTimeAdjustRequest 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, requested_start_time, cause)¶

Initialize the StartTimeAdjustRequest command

Parameters:

device (st.matter.Device) – the device to build this message to
requested_start_time (st.matter.data_types.Uint32)
cause (st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum)

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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.PauseRequest: st.matter.data_types.Structure ¶

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

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

duration: st.matter.data_types.Uint32¶

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum¶

build_test_command_response(device, endpoint_id, status)¶

Builds an PauseRequest 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, duration, cause)¶

Initialize the PauseRequest command

Parameters:

device (st.matter.Device) – the device to build this message to
duration (st.matter.data_types.Uint32)
cause (st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum)

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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.ResumeRequest: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an ResumeRequest 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 ResumeRequest 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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.ModifyForecastRequest: st.matter.data_types.Structure ¶

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

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

forecastid: st.matter.data_types.Uint32¶

slot_adjustments: st.matter.data_types.Array¶

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum¶

build_test_command_response(device, endpoint_id, status)¶

Builds an ModifyForecastRequest 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, forecastid, slot_adjustments, cause)¶

Initialize the ModifyForecastRequest command

Parameters:

device (st.matter.Device) – the device to build this message to
forecastid (st.matter.data_types.Uint32)
slot_adjustments (st.matter.data_types.Array)
cause (st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum)

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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.RequestConstraintBasedForecast: st.matter.data_types.Structure ¶

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

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

constraints: st.matter.data_types.Array¶

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum¶

build_test_command_response(device, endpoint_id, status)¶

Builds an RequestConstraintBasedForecast 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, constraints, cause)¶

Initialize the RequestConstraintBasedForecast command

Parameters:

device (st.matter.Device) – the device to build this message to
constraints (st.matter.data_types.Array)
cause (st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum)

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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.commands.CancelRequest: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an CancelRequest 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 CancelRequest 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)

Events¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.events.PowerAdjustStart: st.matter.data_types.Structure ¶

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

NAME: str¶: “PowerAdjustStart” 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:

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

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 PowerAdjustStart 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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.events.PowerAdjustEnd: st.matter.data_types.Structure ¶

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

NAME: str¶: “PowerAdjustEnd” the name of this event

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.CauseEnum¶

duration: st.matter.data_types.Uint32¶

energy_use: st.matter.data_types.Int64¶

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:

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

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 PowerAdjustEnd 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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.events.Paused: st.matter.data_types.Structure ¶

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

NAME: str¶: “Paused” 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:

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

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 Paused 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)

class st.matter.generated.zap_clusters.DeviceEnergyManagement.server.events.Resumed: st.matter.data_types.Structure ¶

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

NAME: str¶: “Resumed” the name of this event

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.CauseEnum¶

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:

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

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 Resumed test event report reponse to be used by

the driver integration testing framework.

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
fields (table) – containing the event fields
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Bitmap types¶

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

POWER_ADJUSTMENT: number¶: 1

POWER_FORECAST_REPORTING: number¶: 2

STATE_FORECAST_REPORTING: number¶: 4

START_TIME_ADJUSTMENT: number¶: 8

PAUSABLE: number¶: 16

FORECAST_ADJUSTMENT: number¶: 32

CONSTRAINT_BASED_ADJUSTMENT: number¶: 64

is_power_adjustment_set()¶

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

set_power_adjustment()¶: Set the value of the bit in the POWER_ADJUSTMENT field to 1

unset_power_adjustment()¶: Set the value of the bits in the POWER_ADJUSTMENT field to 0

is_power_forecast_reporting_set()¶

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

set_power_forecast_reporting()¶: Set the value of the bit in the POWER_FORECAST_REPORTING field to 1

unset_power_forecast_reporting()¶: Set the value of the bits in the POWER_FORECAST_REPORTING field to 0

is_state_forecast_reporting_set()¶

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

set_state_forecast_reporting()¶: Set the value of the bit in the STATE_FORECAST_REPORTING field to 1

unset_state_forecast_reporting()¶: Set the value of the bits in the STATE_FORECAST_REPORTING field to 0

is_start_time_adjustment_set()¶

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

set_start_time_adjustment()¶: Set the value of the bit in the START_TIME_ADJUSTMENT field to 1

unset_start_time_adjustment()¶: Set the value of the bits in the START_TIME_ADJUSTMENT field to 0

is_pausable_set()¶

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

set_pausable()¶: Set the value of the bit in the PAUSABLE field to 1

unset_pausable()¶: Set the value of the bits in the PAUSABLE field to 0

is_forecast_adjustment_set()¶

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

set_forecast_adjustment()¶: Set the value of the bit in the FORECAST_ADJUSTMENT field to 1

unset_forecast_adjustment()¶: Set the value of the bits in the FORECAST_ADJUSTMENT field to 0

is_constraint_based_adjustment_set()¶

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

set_constraint_based_adjustment()¶: Set the value of the bit in the CONSTRAINT_BASED_ADJUSTMENT field to 1

unset_constraint_based_adjustment()¶: Set the value of the bits in the CONSTRAINT_BASED_ADJUSTMENT field to 0

Enum types¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.AdjustmentCauseEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

LOCAL_OPTIMIZATION: number¶: 0

GRID_OPTIMIZATION: number¶: 1

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.CauseEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

NORMAL_COMPLETION: number¶: 0

OFFLINE: number¶: 1

FAULT: number¶: 2

USER_OPT_OUT: number¶: 3

CANCELLED: number¶: 4

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.CostTypeEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

FINANCIAL: number¶: 0

GHG_EMISSIONS: number¶: 1

COMFORT: number¶: 2

TEMPERATURE: number¶: 3

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ESAStateEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

OFFLINE: number¶: 0

ONLINE: number¶: 1

FAULT: number¶: 2

POWER_ADJUST_ACTIVE: number¶: 3

PAUSED: number¶: 4

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ESATypeEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

EVSE: number¶: 0

SPACE_HEATING: number¶: 1

WATER_HEATING: number¶: 2

SPACE_COOLING: number¶: 3

SPACE_HEATING_COOLING: number¶: 4

BATTERY_STORAGE: number¶: 5

SOLARPV: number¶: 6

FRIDGE_FREEZER: number¶: 7

WASHING_MACHINE: number¶: 8

DISHWASHER: number¶: 9

COOKING: number¶: 10

HOME_WATER_PUMP: number¶: 11

IRRIGATION_WATER_PUMP: number¶: 12

POOL_PUMP: number¶: 13

OTHER: number¶: 255

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ForecastUpdateReasonEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

INTERNAL_OPTIMIZATION: number¶: 0

LOCAL_OPTIMIZATION: number¶: 1

GRID_OPTIMIZATION: number¶: 2

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.OptOutStateEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

NO_OPT_OUT: number¶: 0

LOCAL_OPT_OUT: number¶: 1

GRID_OPT_OUT: number¶: 2

OPT_OUT: number¶: 3

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.PowerAdjustReasonEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

NO_ADJUSTMENT: number¶: 0

LOCAL_OPTIMIZATION_ADJUSTMENT: number¶: 1

GRID_OPTIMIZATION_ADJUSTMENT: number¶: 2

Struct types¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.CostStruct: st.matter.data_types.Structure ¶

cost_type: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.CostTypeEnum¶

value: st.matter.data_types.Int32¶

decimal_points: st.matter.data_types.Uint8¶

currency: st.matter.data_types.Uint16¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.PowerAdjustStruct: st.matter.data_types.Structure ¶

min_power: st.matter.data_types.Int64¶

max_power: st.matter.data_types.Int64¶

min_duration: st.matter.data_types.Uint32¶

max_duration: st.matter.data_types.Uint32¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.PowerAdjustCapabilityStruct: st.matter.data_types.Structure ¶

power_adjust_capability: st.matter.data_types.Array¶

cause: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.PowerAdjustReasonEnum¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.SlotStruct: st.matter.data_types.Structure ¶

min_duration: st.matter.data_types.Uint32¶

max_duration: st.matter.data_types.Uint32¶

default_duration: st.matter.data_types.Uint32¶

elapsed_slot_time: st.matter.data_types.Uint32¶

remaining_slot_time: st.matter.data_types.Uint32¶

slot_is_pausable: st.matter.data_types.Boolean¶

min_pause_duration: st.matter.data_types.Uint32¶

max_pause_duration: st.matter.data_types.Uint32¶

manufacturer_esa_state: st.matter.data_types.Uint16¶

nominal_power: st.matter.data_types.Int64¶

min_power: st.matter.data_types.Int64¶

max_power: st.matter.data_types.Int64¶

nominal_energy: st.matter.data_types.Int64¶

costs: st.matter.data_types.Array¶

min_power_adjustment: st.matter.data_types.Int64¶

max_power_adjustment: st.matter.data_types.Int64¶

min_duration_adjustment: st.matter.data_types.Uint32¶

max_duration_adjustment: st.matter.data_types.Uint32¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ForecastStruct: st.matter.data_types.Structure ¶

forecast_id: st.matter.data_types.Uint32¶

active_slot_number: st.matter.data_types.Uint16¶

start_time: st.matter.data_types.Uint32¶

end_time: st.matter.data_types.Uint32¶

earliest_start_time: st.matter.data_types.Uint32¶

latest_end_time: st.matter.data_types.Uint32¶

is_pausable: st.matter.data_types.Boolean¶

slots: st.matter.data_types.Array¶

forecast_update_reason: st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ForecastUpdateReasonEnum¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.ConstraintsStruct: st.matter.data_types.Structure ¶

start_time: st.matter.data_types.Uint32¶

duration: st.matter.data_types.Uint32¶

nominal_power: st.matter.data_types.Int64¶

maximum_energy: st.matter.data_types.Int64¶

load_control: st.matter.data_types.Int8¶

class st.matter.generated.zap_clusters.DeviceEnergyManagement.types.SlotAdjustmentStruct: st.matter.data_types.Structure ¶

slot_index: st.matter.data_types.Uint8¶

nominal_power: st.matter.data_types.Int64¶

duration: st.matter.data_types.Uint32¶