10.3.11. powermeterΒΆ

Powermeter types

TransactionReq:object
Required input parameter for starting an OCMF transaction. These values will be included in the signed OCMF packet.
required: evse_id, transaction_id, client_id, tariff_id, cable_id, user_data
properties:
evse_id:string
Id of this EVSE
transaction_id:string
OCPP transaction UUID
client_id:string
User identification means, e.g. RFID card ID
tariff_id:integer
Tariff ID
cable_id:integer
Cable ID
user_data:string
User data
TransactionRequestStatus:string
Status of a transaction start or stop request.
enum: OK, NOT_SUPPORTED, UNEXPECTED_ERROR
TransactionStartResponse:object
Return value when a transaction is started.
required: status
properties:
status:** (powermeter-TransactionRequestStatus)
Response status that indicates whether the transaction start request could successfully be performed.
There is an extended definition for this object here.
error:string
If status is not OK, a verbose error message.
transaction_min_stop_time:string
Earliest point in time the started transaction can be stopped again (if a minimum duration is required by the meter); yields a RFC3339 timestamp.
format:
transaction_max_stop_time:string
Deadline for the transaction to be stopped again (if a minimum duration is required by the meter); yields a RFC3339 timestamp.
format:
TransactionStopResponse:object
Report returned when a OCMF transaction is requested to stop. If successful, includes the signed OCMF string. In case of an error, an additional error message can be provided.
required: status
properties:
status:** (powermeter-TransactionRequestStatus)
Response status that indicates whether the transaction stop request could successfully be performed.
There is an extended definition for this object here.
ocmf:string
The signed OCMF report of the stopped transaction. Must be provided if status is OK.
error:string
If status is not OK, a verbose error message.
Powermeter:object
Measured dataset (AC or DC)
required: timestamp, energy_Wh_import
properties:
timestamp:string
Timestamp of measurement
format:
meter_id:string
A (user defined) meter if (e.g. id printed on the case)
phase_seq_error:boolean
AC only: true for 3 phase rotation error (ccw)
energy_Wh_import:object (units-Energy)
Imported energy in Wh (from grid)
There is an extended definition for this object here.
energy_Wh_export:object (units-Energy)
Exported energy in Wh (to grid)
There is an extended definition for this object here.
power_W:object (units-Power)
Instantaneous power in Watt. Negative values are exported, positive values imported Energy.
There is an extended definition for this object here.
voltage_V:object (units-Voltage)
Voltage in Volts
There is an extended definition for this object here.
VAR:object (units-ReactivePower)
Reactive power VAR
There is an extended definition for this object here.
current_A:object (units-Current)
Current in ampere
There is an extended definition for this object here.
frequency_Hz:object (units-Frequency)
Grid frequency in Hertz
There is an extended definition for this object here.