11.3.15. powermeterΒΆ

Powermeter types

TransactionReq:object
Required input parameter for starting an OCMF transaction. These values will be included in the signed OCMF packet.
properties:
evse_id:string <required>
Id of this EVSE
transaction_id:string <required>
OCPP transaction UUID
client_id:string <required>
User identification means, e.g. RFID card ID
tariff_id:integer <required>
Tariff ID
cable_id:integer <required>
Cable ID
user_data:string <required>
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.
properties:
status:string/object <required> (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 <optional>
If status is not OK, a verbose error message.
transaction_min_stop_time:string <optional>
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:date-time
transaction_max_stop_time:string <optional>
Deadline for the transaction to be stopped again (if a minimum duration is required by the meter); yields a RFC3339 timestamp.
format:date-time
TransactionStopResponse:object
Report returned when a signed transaction is requested to stop. If successful, includes the signed meter value object. In case of an error, an additional error message can be provided.
properties:
status:string/object <required> (powermeter-TransactionRequestStatus)
Response status that indicates whether the transaction stop request could successfully be performed.
There is an extended definition for this object here.
signed_meter_value:object <optional> (units_signed-SignedMeterValue)
The signed meter value report of the stopped transaction. Must be provided if status is OK.
There is an extended definition for this object here.
error:string <optional>
If status is not OK, a verbose error message.
Powermeter:object
Measured dataset (AC or DC)
properties:
timestamp:string <required>
Timestamp of measurement
format:date-time
meter_id:string <optional>
A (user defined) meter if (e.g. id printed on the case)
phase_seq_error:boolean <optional>
AC only: true for 3 phase rotation error (ccw)
energy_Wh_import:object <required> (units-Energy)
Imported energy in Wh (from grid)
There is an extended definition for this object here.
energy_Wh_export:object <optional> (units-Energy)
Exported energy in Wh (to grid)
There is an extended definition for this object here.
power_W:object <optional> (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 <optional> (units-Voltage)
Voltage in Volts
There is an extended definition for this object here.
VAR:object <optional> (units-ReactivePower)
Reactive power VAR
There is an extended definition for this object here.
current_A:object <optional> (units-Current)
Current in ampere
There is an extended definition for this object here.
frequency_Hz:object <optional> (units-Frequency)
Grid frequency in Hertz
There is an extended definition for this object here.
energy_Wh_import_signed:object <optional> (units_signed-Energy)
Imported energy in Wh (from grid)
There is an extended definition for this object here.
energy_Wh_export_signed:object <optional> (units_signed-Energy)
Exported energy in Wh (to grid)
There is an extended definition for this object here.
power_W_signed:object <optional> (units_signed-Power)
Instantaneous power in Watt. Negative values are exported, positive values imported Energy.
There is an extended definition for this object here.
voltage_V_signed:object <optional> (units_signed-Voltage)
Voltage in Volts
There is an extended definition for this object here.
VAR_signed:object <optional> (units_signed-ReactivePower)
Reactive power VAR
There is an extended definition for this object here.
current_A_signed:object <optional> (units_signed-Current)
Current in ampere
There is an extended definition for this object here.
frequency_Hz_signed:object <optional> (units_signed-Frequency)
Grid frequency in Hertz
There is an extended definition for this object here.
signed_meter_value:object <optional> (units_signed-SignedMeterValue)
Signed collection of instantaneous meter values if supported by the meter. This is intended for meters that only support signing a collection of meter values.
There is an extended definition for this object here.