EnergyEvse¶
Attributes¶
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.State¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“State” the name of this attribute
- data_type: st.matter.generated.zap_clusters.EnergyEvse.types.StateEnum¶
the data type of this attribute
- new_value(...)¶
Create a StateEnum object of this attribute with any additional features provided for the attribute
This is also usable with the State(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a StateEnum- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: State => 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 State test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.SupplyState¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“SupplyState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.EnergyEvse.types.SupplyStateEnum¶
the data type of this attribute
- new_value(...)¶
Create a SupplyStateEnum object of this attribute with any additional features provided for the attribute
This is also usable with the SupplyState(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SupplyStateEnum- Return type:
st.matter.generated.zap_clusters.EnergyEvse.types.SupplyStateEnum
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: SupplyState => 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 SupplyState test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.FaultState¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“FaultState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.EnergyEvse.types.FaultStateEnum¶
the data type of this attribute
- new_value(...)¶
Create a FaultStateEnum object of this attribute with any additional features provided for the attribute
This is also usable with the FaultState(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a FaultStateEnum- Return type:
st.matter.generated.zap_clusters.EnergyEvse.types.FaultStateEnum
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: FaultState => 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 FaultState test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.ChargingEnabledUntil¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“ChargingEnabledUntil” 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 ChargingEnabledUntil(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: ChargingEnabledUntil => 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 ChargingEnabledUntil test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.DischargingEnabledUntil¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“DischargingEnabledUntil” 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 DischargingEnabledUntil(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: DischargingEnabledUntil => 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 DischargingEnabledUntil test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.CircuitCapacity¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“CircuitCapacity” 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 CircuitCapacity(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: CircuitCapacity => 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 CircuitCapacity test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.MinimumChargeCurrent¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“MinimumChargeCurrent” 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 MinimumChargeCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: MinimumChargeCurrent => 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 MinimumChargeCurrent test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.MaximumChargeCurrent¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“MaximumChargeCurrent” 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 MaximumChargeCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: MaximumChargeCurrent => 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 MaximumChargeCurrent test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.MaximumDischargeCurrent¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“MaximumDischargeCurrent” 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 MaximumDischargeCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: MaximumDischargeCurrent => 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 MaximumDischargeCurrent test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.UserMaximumChargeCurrent¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“UserMaximumChargeCurrent” 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 UserMaximumChargeCurrent(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int64) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: UserMaximumChargeCurrent => 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 UserMaximumChargeCurrent test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.RandomizationDelayWindow¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“RandomizationDelayWindow” 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 RandomizationDelayWindow(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint32) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: RandomizationDelayWindow => 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 RandomizationDelayWindow test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.NextChargeStartTime¶
- ID: number¶
0x0023 the ID of this attribute
- NAME: str¶
“NextChargeStartTime” 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 NextChargeStartTime(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: NextChargeStartTime => 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 NextChargeStartTime test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.NextChargeTargetTime¶
- ID: number¶
0x0024 the ID of this attribute
- NAME: str¶
“NextChargeTargetTime” 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 NextChargeTargetTime(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: NextChargeTargetTime => 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 NextChargeTargetTime test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.NextChargeRequiredEnergy¶
- ID: number¶
0x0025 the ID of this attribute
- NAME: str¶
“NextChargeRequiredEnergy” 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 NextChargeRequiredEnergy(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: NextChargeRequiredEnergy => 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 NextChargeRequiredEnergy test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.NextChargeTargetSoC¶
- ID: number¶
0x0026 the ID of this attribute
- NAME: str¶
“NextChargeTargetSoC” 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 NextChargeTargetSoC(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: NextChargeTargetSoC => 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 NextChargeTargetSoC test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.ApproximateEVEfficiency¶
- ID: number¶
0x0027 the ID of this attribute
- NAME: str¶
“ApproximateEVEfficiency” 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 ApproximateEVEfficiency(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- Return type:
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ApproximateEVEfficiency => 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 ApproximateEVEfficiency test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.StateOfCharge¶
- ID: number¶
0x0030 the ID of this attribute
- NAME: str¶
“StateOfCharge” 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 StateOfCharge(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: StateOfCharge => 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 StateOfCharge test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.BatteryCapacity¶
- ID: number¶
0x0031 the ID of this attribute
- NAME: str¶
“BatteryCapacity” 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 BatteryCapacity(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: BatteryCapacity => 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 BatteryCapacity test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.VehicleID¶
- ID: number¶
0x0032 the ID of this attribute
- NAME: str¶
“VehicleID” 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 VehicleID(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a UTF8String1- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: VehicleID => 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 VehicleID test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.SessionID¶
- ID: number¶
0x0040 the ID of this attribute
- NAME: str¶
“SessionID” 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 SessionID(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: SessionID => 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 SessionID test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.SessionDuration¶
- ID: number¶
0x0041 the ID of this attribute
- NAME: str¶
“SessionDuration” 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 SessionDuration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: SessionDuration => 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 SessionDuration test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.SessionEnergyCharged¶
- ID: number¶
0x0042 the ID of this attribute
- NAME: str¶
“SessionEnergyCharged” 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 SessionEnergyCharged(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: SessionEnergyCharged => 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 SessionEnergyCharged test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.attributes.SessionEnergyDischarged¶
- ID: number¶
0x0043 the ID of this attribute
- NAME: str¶
“SessionEnergyDischarged” 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 SessionEnergyDischarged(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: SessionEnergyDischarged => 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 SessionEnergyDischarged test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.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:
- 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:
- 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 forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.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:
- 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:
- 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 forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Client Commands¶
- class st.matter.generated.zap_clusters.EnergyEvse.client.commands.GetTargetsResponse: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“GetTargetsResponse” the name of this command
- charging_target_schedules: st.matter.data_types.Array¶
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- build_test_command_response(device, endpoint_id, charging_target_schedules)¶
Builds an GetTargetsResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)charging_target_schedules (
st.matter.data_types.Array)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the GetTargetsResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Server Commands¶
- class st.matter.generated.zap_clusters.EnergyEvse.server.commands.Disable: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“Disable” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an Disable test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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 Disable command
- Parameters:
device (
st.matter.Device) – the device to build this message to- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.commands.EnableCharging: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this command
- NAME: str¶
“EnableCharging” the name of this command
- charging_enabled_until: st.matter.data_types.Uint32¶
- minimum_charge_current: st.matter.data_types.Int64¶
- maximum_charge_current: st.matter.data_types.Int64¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an EnableCharging test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, charging_enabled_until, minimum_charge_current, maximum_charge_current)¶
Initialize the EnableCharging command
- Parameters:
device (
st.matter.Device) – the device to build this message tocharging_enabled_until (
st.matter.data_types.Uint32)minimum_charge_current (
st.matter.data_types.Int64)maximum_charge_current (
st.matter.data_types.Int64)
- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.commands.EnableDischarging: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this command
- NAME: str¶
“EnableDischarging” the name of this command
- discharging_enabled_until: st.matter.data_types.Uint32¶
- maximum_discharge_current: st.matter.data_types.Int64¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an EnableDischarging test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, discharging_enabled_until, maximum_discharge_current)¶
Initialize the EnableDischarging command
- Parameters:
device (
st.matter.Device) – the device to build this message todischarging_enabled_until (
st.matter.data_types.Uint32)maximum_discharge_current (
st.matter.data_types.Int64)
- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.commands.StartDiagnostics: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this command
- NAME: str¶
“StartDiagnostics” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an StartDiagnostics test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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 StartDiagnostics command
- Parameters:
device (
st.matter.Device) – the device to build this message to- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.commands.SetTargets: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this command
- NAME: str¶
“SetTargets” the name of this command
- charging_target_schedules: st.matter.data_types.Array¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetTargets test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, charging_target_schedules)¶
Initialize the SetTargets command
- Parameters:
device (
st.matter.Device) – the device to build this message tocharging_target_schedules (
st.matter.data_types.Array)
- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.commands.GetTargets: st.matter.data_types.Structure¶
- ID: number¶
0x0006 the ID of this command
- NAME: str¶
“GetTargets” the name of this command
- init(device)¶
Refer to GetTargetsResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the GetTargets command
- Parameters:
device (
st.matter.Device) – the device to build this message to- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.commands.ClearTargets: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this command
- NAME: str¶
“ClearTargets” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an ClearTargets test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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 ClearTargets command
- Parameters:
device (
st.matter.Device) – the device to build this message to- Returns:
of type INVOKE
- Return type:
- 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.EnergyEvse.server.events.EVConnected: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this event
- NAME: str¶
“EVConnected” the name of this event
- sessionid: st.matter.data_types.Uint32¶
- 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:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an EVConnected test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.events.EVNotDetected: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this event
- NAME: str¶
“EVNotDetected” the name of this event
- sessionid: st.matter.data_types.Uint32¶
- state: st.matter.generated.zap_clusters.EnergyEvse.types.StateEnum¶
- session_duration: st.matter.data_types.Uint32¶
- session_energy_charged: st.matter.data_types.Int64¶
- session_energy_discharged: 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:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an EVNotDetected test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.events.EnergyTransferStarted: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this event
- NAME: str¶
“EnergyTransferStarted” the name of this event
- sessionid: st.matter.data_types.Uint32¶
- state: st.matter.generated.zap_clusters.EnergyEvse.types.StateEnum¶
- maximum_current: st.matter.data_types.Int64¶
- maximum_discharge_current: 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:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an EnergyTransferStarted test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.events.EnergyTransferStopped: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this event
- NAME: str¶
“EnergyTransferStopped” the name of this event
- sessionid: st.matter.data_types.Uint32¶
- state: st.matter.generated.zap_clusters.EnergyEvse.types.StateEnum¶
- reason: st.matter.generated.zap_clusters.EnergyEvse.types.EnergyTransferStoppedReasonEnum¶
- energy_transferred: st.matter.data_types.Int64¶
- energy_discharged: 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:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an EnergyTransferStopped test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.events.Fault: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this event
- NAME: str¶
“Fault” the name of this event
- sessionid: st.matter.data_types.Uint32¶
- state: st.matter.generated.zap_clusters.EnergyEvse.types.StateEnum¶
- fault_state_previous_state: st.matter.generated.zap_clusters.EnergyEvse.types.FaultStateEnum¶
- fault_state_current_state: st.matter.generated.zap_clusters.EnergyEvse.types.FaultStateEnum¶
- 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:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an Fault test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.EnergyEvse.server.events.Rfid: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this event
- NAME: str¶
“Rfid” the name of this event
- uid: st.matter.data_types.OctetString1¶
- 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:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an Rfid test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Bitmap types¶
- class st.matter.generated.zap_clusters.EnergyEvse.types.Feature¶
- CHARGING_PREFERENCES: number¶
1
- SOC_REPORTING: number¶
2
- PLUG_AND_CHARGE: number¶
4
- RFID: number¶
8
- V2X: number¶
16
- is_charging_preferences_set()¶
- Returns:
True if the value of CHARGING_PREFERENCES is non-zero
- Return type:
boolean
- set_charging_preferences()¶
Set the value of the bit in the CHARGING_PREFERENCES field to 1
- unset_charging_preferences()¶
Set the value of the bits in the CHARGING_PREFERENCES field to 0
- is_soc_reporting_set()¶
- Returns:
True if the value of SOC_REPORTING is non-zero
- Return type:
boolean
- set_soc_reporting()¶
Set the value of the bit in the SOC_REPORTING field to 1
- unset_soc_reporting()¶
Set the value of the bits in the SOC_REPORTING field to 0
- is_plug_and_charge_set()¶
- Returns:
True if the value of PLUG_AND_CHARGE is non-zero
- Return type:
boolean
- set_plug_and_charge()¶
Set the value of the bit in the PLUG_AND_CHARGE field to 1
- unset_plug_and_charge()¶
Set the value of the bits in the PLUG_AND_CHARGE field to 0
- is_rfid_set()¶
- Returns:
True if the value of RFID is non-zero
- Return type:
boolean
- set_rfid()¶
Set the value of the bit in the RFID field to 1
- unset_rfid()¶
Set the value of the bits in the RFID field to 0
- is_v2x_set()¶
- Returns:
True if the value of V2X is non-zero
- Return type:
boolean
- set_v2x()¶
Set the value of the bit in the V2X field to 1
- unset_v2x()¶
Set the value of the bits in the V2X field to 0
- class st.matter.generated.zap_clusters.EnergyEvse.types.TargetDayOfWeekBitmap¶
- SUNDAY: number¶
1
- MONDAY: number¶
2
- TUESDAY: number¶
4
- WEDNESDAY: number¶
8
- THURSDAY: number¶
16
- FRIDAY: number¶
32
- SATURDAY: number¶
64
- is_sunday_set()¶
- Returns:
True if the value of SUNDAY is non-zero
- Return type:
boolean
- set_sunday()¶
Set the value of the bit in the SUNDAY field to 1
- unset_sunday()¶
Set the value of the bits in the SUNDAY field to 0
- is_monday_set()¶
- Returns:
True if the value of MONDAY is non-zero
- Return type:
boolean
- set_monday()¶
Set the value of the bit in the MONDAY field to 1
- unset_monday()¶
Set the value of the bits in the MONDAY field to 0
- is_tuesday_set()¶
- Returns:
True if the value of TUESDAY is non-zero
- Return type:
boolean
- set_tuesday()¶
Set the value of the bit in the TUESDAY field to 1
- unset_tuesday()¶
Set the value of the bits in the TUESDAY field to 0
- is_wednesday_set()¶
- Returns:
True if the value of WEDNESDAY is non-zero
- Return type:
boolean
- set_wednesday()¶
Set the value of the bit in the WEDNESDAY field to 1
- unset_wednesday()¶
Set the value of the bits in the WEDNESDAY field to 0
- is_thursday_set()¶
- Returns:
True if the value of THURSDAY is non-zero
- Return type:
boolean
- set_thursday()¶
Set the value of the bit in the THURSDAY field to 1
- unset_thursday()¶
Set the value of the bits in the THURSDAY field to 0
- is_friday_set()¶
- Returns:
True if the value of FRIDAY is non-zero
- Return type:
boolean
- set_friday()¶
Set the value of the bit in the FRIDAY field to 1
- unset_friday()¶
Set the value of the bits in the FRIDAY field to 0
- is_saturday_set()¶
- Returns:
True if the value of SATURDAY is non-zero
- Return type:
boolean
- set_saturday()¶
Set the value of the bit in the SATURDAY field to 1
- unset_saturday()¶
Set the value of the bits in the SATURDAY field to 0
Enum types¶
- class st.matter.generated.zap_clusters.EnergyEvse.types.EnergyTransferStoppedReasonEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- EV_STOPPED: number¶
0
- EVSE_STOPPED: number¶
1
- OTHER: number¶
2
- class st.matter.generated.zap_clusters.EnergyEvse.types.FaultStateEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- NO_ERROR: number¶
0
- METER_FAILURE: number¶
1
- OVER_VOLTAGE: number¶
2
- UNDER_VOLTAGE: number¶
3
- OVER_CURRENT: number¶
4
- CONTACT_WET_FAILURE: number¶
5
- CONTACT_DRY_FAILURE: number¶
6
- GROUND_FAULT: number¶
7
- POWER_LOSS: number¶
8
- POWER_QUALITY: number¶
9
- PILOT_SHORT_CIRCUIT: number¶
10
- EMERGENCY_STOP: number¶
11
- EV_DISCONNECTED: number¶
12
- WRONG_POWER_SUPPLY: number¶
13
- LIVE_NEUTRAL_SWAP: number¶
14
- OVER_TEMPERATURE: number¶
15
- OTHER: number¶
255
- class st.matter.generated.zap_clusters.EnergyEvse.types.StateEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- NOT_PLUGGED_IN: number¶
0
- PLUGGED_IN_NO_DEMAND: number¶
1
- PLUGGED_IN_DEMAND: number¶
2
- PLUGGED_IN_CHARGING: number¶
3
- PLUGGED_IN_DISCHARGING: number¶
4
- SESSION_ENDING: number¶
5
- FAULT: number¶
6
Struct types¶
- class st.matter.generated.zap_clusters.EnergyEvse.types.ChargingTargetStruct: st.matter.data_types.Structure¶
- target_time_minutes_past_midnight: st.matter.data_types.Uint16¶
- target_so_c: st.matter.data_types.Uint8¶
- added_energy: st.matter.data_types.Int64¶
- class st.matter.generated.zap_clusters.EnergyEvse.types.ChargingTargetScheduleStruct: st.matter.data_types.Structure¶
- day_of_week_for_sequence: st.matter.generated.zap_clusters.EnergyEvse.types.TargetDayOfWeekBitmap¶
- charging_targets: st.matter.data_types.Array¶