11.3.7. evse_manager

EVSE manager types

StopTransactionRequest:object
Request for a stop transaction containing the reason and an optional id tag
required: reason
properties:
reason:string (evse_manager-StopTransactionReason)
Reason for stopping the transaction
There is an extended definition for this object here.
id_tag:object (authorization-ProvidedIdToken)
Id tag that was used to stop the transaction. Only present if transaction was stopped locally.
There is an extended definition for this object here.
StopTransactionReason:string
Reason for stopping transaction
EmergencyStop: Emergency stop button was used
EVDisconnected: Disconnecting of cable, vehicle moved away from inductive charge unit
HardReset: A hard reset command was received previously
Local: Stopped locally on request of the user at the Charge Point. This is a regular termination of a transaction. Examples: presenting an RFID tag, pressing a button to stop
Other: Any other reason
PowerLoss: Complete loss of power
Reboot: A locally initiated reset/reboot occurred
Remote: Stopped remotely on request of the user. This is a regular termination of a transaction. Examples: termination using a smartphone app, exceeding a (non local) prepaid credit
SoftReset: A soft reset command was received
UnlockCommand: Central System sent an Unlock Connector command
DeAuthorized: The transaction was stopped because of the authorization status in a StartTransaction.conf
EnergyLimitReached: Maximum energy of charging reached. For example: in a pre-paid charging solution
GroundFault: A GroundFault has occurred
LocalOutOfCredit: A local credit limit enforced through the Charging Station has been exceeded.
MasterPass: The transaction was stopped using a token with a MasterPassGroupId.
OvercurrentFault: A larger than intended electric current has occurred
PowerQuality: Quality of power too low, e.g. voltage too low/high, phase imbalance, etc.
SOCLimitReached: Electric vehicle has reported reaching a locally enforced maximum battery State of Charge (SOC)
StoppedByEV: The transaction was stopped by the EV
TimeLimitReached: EV charging session reached a locally enforced time limit
Timeout: EV not connected within timeout
enum: EmergencyStop, EVDisconnected, HardReset, Local, Other, PowerLoss, Reboot, Remote, SoftReset, UnlockCommand, DeAuthorized, EnergyLimitReached, GroundFault, LocalOutOfCredit, MasterPass, OvercurrentFault, PowerQuality, SOCLimitReached, StoppedByEV, TimeLimitReached, Timeout
StartSessionReason:string
Reason for session start
EVConnected: Session was started because an EV was plugged in
Authorized: Session was started because a valid authorization was presented and the EVSE is authorized to start a transaction immediately when an EV is plugged in
enum: EVConnected, Authorized
SwitchThreePhasesWhileChargingResult:string
Returns success or error code
Success: Switching phases was successful
Error_NotSupported: Switching phases is not supported
Error_NotCharging: EVSE is not charging
Error_Hardware: There was a hardware error on switching phases
enum: Success, Error_NotSupported, Error_NotCharging, Error_Hardware
SessionEventEnum:string
Session Event enum
Enabled: Signaled when the EVSE is enabled (e.g. after an enable command)
Disabled: Signaled when the EVSE is disabled (e.g. after a disable command)
SessionStarted: Signaled when a session has been started. A session has been started either when an EV is plugged in or the user has been authorized to start a transaction (e.g. after an authorize command)
AuthRequired: Signaled when an EVSE needs authorization to start a transaction
TransactionStarted: Signaled when a transaction has been started. Transaction starts at the point that all conditions for charging are met: EV is connected and user has been authorized
PrepareCharging: EVSE started to prepare for charging. DC: CableCheck, PreCharge, PowerDelivery. AC: wait for the car to proceed to state C/D
ChargingStarted: DC: CurrentDemand has started. AC: Auth is ok and car requested power (state C/D)
ChargingPausedEV: Signaled when charging is paused by the EV
ChargingPausedEVSE: Signaled when charging is paused by the EVSE
ChargingResumed: Charging has resumed from a pause
StoppingCharging: EVSE has started to stop the charging process. DC: CurrentDemand has finished, now doing WeldingCheck etc, AC: Wait for car to return to state B or A
ChargingFinished: Charging is finished. Essentially the same as TransactionFinished, but emitted for clarity
TransactionFinished: Signaled when the transaction finished. Transaction finishes at the point where one of the preconditions for charging irrevocably becomes false: When a user swipes to stop the transaction and the stop is authorized.
SessionFinished: Session finishes at the point that the EVSE is available again (no cable plugged)
Error: Signaled when an error occured. An error doesnt prevent further charging operations.
AllErrorsCleared: Signalled when all errors are cleared
PermanentFault: Signaled when there is a permanent fault at the EVSE. A permanent fault prevents further charging operations
ReservationStart: Signaled when a reservation starts
ReservationEnd: Signaled when a reservation ends
ReplugStarted: Signaled when the EVSE Manager virtually replugs without interrupting the session or transaction
ReplugFinished: Signaled when the virtual replug process has finished
PluginTimeout: Signaled when an EV has been Plugged in but no authorization is present within specified ConnectionTimeout
enum: Enabled, Disabled, SessionStarted, AuthRequired, TransactionStarted, PrepareCharging, ChargingStarted, ChargingPausedEV, ChargingPausedEVSE, WaitingForEnergy, ChargingResumed, StoppingCharging, ChargingFinished, TransactionFinished, SessionFinished, Error, ErrorCleared, AllErrorsCleared, PermanentFault, PermanentFaultCleared, ReservationStart, ReservationEnd, ReplugStarted, ReplugFinished, PluginTimeout
SessionStarted:object
Data for the SessionStarted event
required: timestamp, reason
properties:
timestamp:string
Session start time in RFC3339 format
format:
reason:string (evse_manager-StartSessionReason)
Reason for session start
There is an extended definition for this object here.
logging_path:string
File system path where additional log files are stored, such as event logs, raw ethernet dumps, ocpp session logs etc. Filenames should start with “incomplete-” when they are not finished yet, this allows other process to wait for the completion after the SessionFinished event.
SessionFinished:object
Data for the SessionFinished event
required: timestamp
properties:
timestamp:string
Session start time in RFC3339 format
format:
TransactionStarted:object
Data for the TransactionStarted event
required: timestamp, meter_value, id_tag
properties:
timestamp:string
Transaction start time in RFC3339 format
format:
id_tag:object (authorization-ProvidedIdToken)
The id tag assigned to this transaction
There is an extended definition for this object here.
meter_value:object (powermeter-Powermeter)
Transaction start exported meter value
There is an extended definition for this object here.
signed_meter_value:string
Signed meter value
reservation_id:integer
Id of the reservation
TransactionFinished:object
Data for TransactionFinished event
required: timestamp, meter_value
properties:
timestamp:string
Transaction end time in RFC3339 format
format:
meter_value:object (powermeter-Powermeter)
Transaction finished meter value
There is an extended definition for this object here.
signed_meter_value:string
Signed meter value
reason:string (evse_manager-StopTransactionReason)
Reason for stopping transaction
There is an extended definition for this object here.
id_tag:object (authorization-ProvidedIdToken)
Id tag that was used to stop the transaction. Only present if transaction was stopped locally.
There is an extended definition for this object here.
ErrorEnum:string
Note this is only kept for compatibility with the legacy error handling and will be removed soon.
enum: RCD_Selftest, RCD_DC, RCD_AC, VendorError, VendorWarning, ConnectorLockCapNotCharged, ConnectorLockUnexpectedOpen, ConnectorLockUnexpectedClose, ConnectorLockFailedLock, ConnectorLockFailedUnlock, MREC1ConnectorLockFailure, MREC2GroundFailure, MREC3HighTemperature, MREC4OverCurrentFailure, MREC5OverVoltage, MREC6UnderVoltage, MREC8EmergencyStop, MREC10InvalidVehicleMode, MREC14PilotFault, MREC15PowerLoss, MREC17EVSEContactorFault, MREC18CableOverTempDerate, MREC19CableOverTempStop, MREC20PartialInsertion, MREC23ProximityFault, MREC24ConnectorVoltageHigh, MREC25BrokenLatch, MREC26CutCable, DiodeFault, VentilationNotAvailable, BrownOut, EnergyManagement, PermanentFault, PowermeterTransactionStartFailed
Error:object
Error object that contains information about the error and optional vendor error information
required: error_code, error_description, error_severity
properties:
error_code:string (evse_manager-ErrorEnum)
The error enum
There is an extended definition for this object here.
error_description:string
Description of the error (human readable)
error_severity:string
Severity of the error
enum: High, Medium, Low
vendor_error:string
The error code of the vendor
SessionEvent:object
Emits all events related to sessions
required: uuid, event
properties:
uuid:string
An EVSE generated UUID for this session, can be used e.g. for database storage.
connector_id:integer
Id of the connector of this EVSE. If the connector_id is not specified, its assumed to be 1
event:string (evse_manager-SessionEventEnum)
Event enum. For some events an additional object is set, see below.
There is an extended definition for this object here.
session_started:object (evse_manager-SessionStarted)
data for SessionStarted event
There is an extended definition for this object here.
session_finished:object (evse_manager-SessionFinished)
data for the SessionFinished event
There is an extended definition for this object here.
transaction_started:object (evse_manager-TransactionStarted)
data for TransactionStarted event
There is an extended definition for this object here.
transaction_finished:object (evse_manager-TransactionFinished)
data for TransactionFinished event that happens when car is plugged out
There is an extended definition for this object here.
error:object (evse_manager-Error)
Details on error type
There is an extended definition for this object here.
Limits:object
Limits of this EVSE
required: max_current, nr_of_phases_available
properties:
uuid:string
This module’s UUID for global identification
max_current:number
Instantaneous maximum current available to car
nr_of_phases_available:integer
Instantaneous phase count available to car
EVInfo:object
Information about the connected EV if available
properties:
soc:number
State of charge of the vehicle’s battery in percent
present_voltage:number
Current voltage of the vehicles battery [V]
present_current:number
Current current of the vehicles battery [A]
target_voltage:number
Target voltage that the vehicle requested [V]
target_current:number
Target current that the vehicle requested [A]
maximum_current_limit:number
Maximum current that the vehicle supports [A]
minimum_current_limit:number
Charging below this limit is not energy efficient [A]
maximum_voltage_limit:number
Maximum voltage that the vehicle supports [V]
maximum_power_limit:number
Maximum power that the vehicle supports [W]
estimated_time_full:string
Estimated time when the vehicle is fully charged
format:
departure_time:string
Time when the vehicle intends to depart (If set by the user)
format:
estimated_time_bulk:string
Estimated time when the vehicle finished bulk charging (e.g. 80%)
format:
evcc_id:string
EVCC ID (typically MAC address)
pattern:
remaining_energy_needed:number
Remaining energy needed to fulfill charging goal [Wh]
battery_capacity:number
Vehicle’s battery capacity [Wh]
battery_full_soc:number
SoC which the vehicle considers fully charged [%]
battery_bulk_soc:number
SoC which the vehicle considers bulk charging reached [%]
CarManufacturer:string
Enum type for car manufacturers derived from MAC address. May be different from actual brand, so e.g. Skoda falls under Volkswagen_Group.
enum: VolkswagenGroup, Tesla, Unknown
Connector:object
Type for a connector which is an independently operated and managed electrical outlet of an EVSE. It corresponds to a single physical connector
required: id
properties:
id:integer
Id of the connector. Connectors should be numbered starting with 1 counting upwards
type:string (evse_manager-ConnectorTypeEnum)
Type of the connector
There is an extended definition for this object here.
ConnectorTypeEnum:string
Type of a physical connector cCCS1: Combined Charging System 1 a.k.a. Combo 1 cCCS2: Combined Charging System 2 a.k.a. Combo 2 cG105: JARI G105-1993 a.k.a. CHAdeMO cTesla: Tesla Connector cType1: IEC62196-2 Type 1 connector a.k.a. J1772 cType2: IEC62196-2 Type 2 connector a.k.a. Mennekes connector s309_1P_16A: 16A 1 phase IEC60309 socket s309_1P_32A: 32A 1 phase IEC60309 socket s309_3P_16A: 16A 3 phase IEC60309 socket s309_3P_32A: 32A 3 phase IEC60309 socket sBS1361: UK domestic socket a.k.a. 13Amp sCEE-7_7: CEE 7/7 16A socket a.k.a Schuko sType2: IEC62196-2 Type 2 socket a.k.a. Mennekes connector sType3: IEC62196-2 Type 2 socket a.k.a. Scame Unknown: Unknown
enum: cCCS1, cCCS2, cG105, cTesla, cType1, cType2, s309_1P_16A, s309_1P_32A, s309_3P_16A, s309_3P_32A, sBS1361, sCEE_7_7, sType2, sType3, Unknown
Evse:object
Type that defines properties of an EVSE including its connectors
required: id, connectors
properties:
id:integer
ID of the EVSE
connectors:array
List of connectors of this EVSE
items:
description:
type:
$ref: