API for EVerest API clients implementing evse board support, AC RCD and connector lock. Commands without arguments carry an empty JSON object ({}) as payload.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Enables or disables the charging port. Typically disabled results in control pilot state F. It must not accept cars for new charging sessions if disabled.
True: enabled. False: disabled.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Turns PWM on with duty cycle (in percent)
EVerest only requests duty cycles strictly between 0 and 100 (5 % for high level communication, 10 % for 6 A up to 97 % for 80 A). State X1 (no current available, PWM off) is requested with cp_state_X1 and state F with cp_state_F, never as a duty cycle of 100 or 0 here.
PWM duty cycle in percent, strictly between 0 and 100. EVerest requests 100 % (X1) and 0 % (F) through cp_state_X1 and cp_state_F instead.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Turn PWM off and set CP to constant high voltage (state X1)
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Turn PWM off with error F (constant negative voltage)
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Set CP to 0 V (state E)
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Sets allow_power_on flag. If false, relays must never be switched on.
Flag and context for switching power on/off. In some architectures e.g. DC power train needs to know whether it should switch on with limited current or full current on the output contactors.
{
"allow_power_on": true,
"reason": "DCCableCheck"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Optional, in case of doubt do not implement. Report in hardware_capabilites if this command is supported. This command switches between one and three phase operation during an active charging session. Some cars can be permanently destroyed by that, so the bsp needs to implement a special sequence for the switching. The exact sequence can be defined by the BSP, but one example would be a C2->C1->B1->F->B1->B2->C2 or similar. Use with caution.
Number of active phases for AC charging
ThreePhases
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Many chargers implement a fast over current shutdown directly in the hardware that triggers if the EV draws more current than the PWM allows. If the hardware does not have this functionality, just ignore this command. Do not use it to set the PWM duty cycle. Otherwise this command reports a value that should be used for the overcurrent detection. A margin needs to be added to avoid false triggers. Do not use the PWM duty cycle to infer the current limit in the BSP, as this will not work with HLC.
Electrical current in ampere (A)
Accepts the following message:
Event from ControlPilot signal/out relais
Event stream from ControlPilot signal/relais.
{
"event": "A"
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Instantaneous phase count available to car
Values outside 1..3 are rejected with a log warning. Not required at start: the initial phase count comes from max_phase_count_import of the capabilities.
Number of phases
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Hardware capabilities/limits. Publish them once after start, before the first charging session: on AC, EVerest does not offer current before it has them, and on AC and DC they set connector_type and supports_cp_state_E. Publish them again whenever a limit changes, e.g. when the maximum current drops because the hardware gets too hot.
Hardware capabilities / limits
{
"max_current_A_import": 5,
"min_current_A_import": 1,
"max_phase_count_import": 3,
"min_phase_count_import": 1,
"max_current_A_export": 10,
"min_current_A_export": 1,
"max_phase_count_export": 3,
"min_phase_count_export": 1,
"supports_changing_phases_during_charging": true,
"max_plug_temperature_C": 80,
"supports_cp_state_E": true,
"connector_type": "IEC62196Type2Cable"
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Current carrying capacity of the connected cable in ampere for AC charging with a socket. Publish whenever it changes. This has no meaning for DC or AC charging with a fixed attached cable, it does not need to be implemented and the returned value is not used in those cases.
Current capability (ampacity) of the cable
{
"ampacity": "None"
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Publish to stop the transaction gracefully (e.g. user pressed the stop button)
Request for a stop transaction containing the reason and an optional id tag
{
"reason": "Local"
}
Accepts the following message:
Executes a self test of the RCD. If it fails, an error of type Selftest should be raised.
Accepts the following message:
Resets the RCD after a trigger. May not be supported by actual hardware.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Accepts the following message:
Reply to provided topic.
Success: true, failure: false
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Residual current in mA. Note that this does not trigger anything, it is merely for reporting.
Electrical current in milliampere (mA)
Accepts the following message:
Lock connector lock
Accepts the following message:
Unlock connector lock. (e.g. normal unlock or enforced by OCPP)
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Signal to EVerest that an error happened.
Errors for the evse_board_support interface. All error codes that begin with MREC needs to be implemented to fulfill the Minimum Required Error Codes defined by the ChargeX consortium: https://inl.gov/content/uploads/2023/07/ChargeX_MREC_Rev5_09.12.23.pdf
{
"type": "DiodeFault",
"sub_type": "string",
"message": "string"
}
Accepts the following message:
Signal to EVerest that a previously raised error is no longer active.
Errors for the evse_board_support interface. All error codes that begin with MREC needs to be implemented to fulfill the Minimum Required Error Codes defined by the ChargeX consortium: https://inl.gov/content/uploads/2023/07/ChargeX_MREC_Rev5_09.12.23.pdf
{
"type": "DiodeFault",
"sub_type": "string",
"message": "string"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send true at least every cfg_communication_check_to_s seconds to signal that the client is alive, otherwise EVerest raises a CommunicationFault, which the next message clears. Send false to stop the check until the module restarts.
Enables or disables the charging port. Typically disabled results in control pilot state F. It must not accept cars for new charging sessions if disabled.
True: enabled. False: disabled.
Turns PWM on with duty cycle (in percent)
EVerest only requests duty cycles strictly between 0 and 100 (5 % for high level communication, 10 % for 6 A up to 97 % for 80 A). State X1 (no current available, PWM off) is requested with cp_state_X1 and state F with cp_state_F, never as a duty cycle of 100 or 0 here.
PWM duty cycle in percent, strictly between 0 and 100. EVerest requests 100 % (X1) and 0 % (F) through cp_state_X1 and cp_state_F instead.
Turn PWM off and set CP to constant high voltage (state X1)
Turn PWM off with error F (constant negative voltage)
Set CP to 0 V (state E)
Sets allow_power_on flag. If false, relays must never be switched on.
Flag and context for switching power on/off. In some architectures e.g. DC power train needs to know whether it should switch on with limited current or full current on the output contactors.
Optional, in case of doubt do not implement. Report in hardware_capabilites if this command is supported. This command switches between one and three phase operation during an active charging session. Some cars can be permanently destroyed by that, so the bsp needs to implement a special sequence for the switching. The exact sequence can be defined by the BSP, but one example would be a C2->C1->B1->F->B1->B2->C2 or similar. Use with caution.
Number of active phases for AC charging
Many chargers implement a fast over current shutdown directly in the hardware that triggers if the EV draws more current than the PWM allows. If the hardware does not have this functionality, just ignore this command. Do not use it to set the PWM duty cycle. Otherwise this command reports a value that should be used for the overcurrent detection. A margin needs to be added to avoid false triggers. Do not use the PWM duty cycle to infer the current limit in the BSP, as this will not work with HLC.
Electrical current in ampere (A)
Event from ControlPilot signal/out relais
Event stream from ControlPilot signal/relais.
Instantaneous phase count available to car
Values outside 1..3 are rejected with a log warning. Not required at start: the initial phase count comes from max_phase_count_import of the capabilities.
Number of phases
Hardware capabilities/limits. Publish them once after start, before the first charging session: on AC, EVerest does not offer current before it has them, and on AC and DC they set connector_type and supports_cp_state_E. Publish them again whenever a limit changes, e.g. when the maximum current drops because the hardware gets too hot.
Hardware capabilities / limits
Current carrying capacity of the connected cable in ampere for AC charging with a socket. Publish whenever it changes. This has no meaning for DC or AC charging with a fixed attached cable, it does not need to be implemented and the returned value is not used in those cases.
Current capability (ampacity) of the cable
Publish to stop the transaction gracefully (e.g. user pressed the stop button)
Request for a stop transaction containing the reason and an optional id tag
Executes a self test of the RCD. If it fails, an error of type Selftest should be raised.
Resets the RCD after a trigger. May not be supported by actual hardware.
Reply to provided topic.
Success: true, failure: false
Residual current in mA. Note that this does not trigger anything, it is merely for reporting.
Electrical current in milliampere (mA)
Lock connector lock
Unlock connector lock. (e.g. normal unlock or enforced by OCPP)
Signal to EVerest that an error happened.
Errors for the evse_board_support interface. All error codes that begin with MREC needs to be implemented to fulfill the Minimum Required Error Codes defined by the ChargeX consortium: https://inl.gov/content/uploads/2023/07/ChargeX_MREC_Rev5_09.12.23.pdf
Signal to EVerest that a previously raised error is no longer active.
Errors for the evse_board_support interface. All error codes that begin with MREC needs to be implemented to fulfill the Minimum Required Error Codes defined by the ChargeX consortium: https://inl.gov/content/uploads/2023/07/ChargeX_MREC_Rev5_09.12.23.pdf
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send true at least every cfg_communication_check_to_s seconds to signal that the client is alive, otherwise EVerest raises a CommunicationFault, which the next message clears. Send false to stop the check until the module restarts.
Number of active phases for AC charging
Event stream from ControlPilot signal/relais.
Electrical current in milliampere (mA)
True: enabled. False: disabled.
Hardware capabilities / limits
Electrical current in ampere (A)
Number of phases
Flag and context for switching power on/off. In some architectures e.g. DC power train needs to know whether it should switch on with limited current or full current on the output contactors.
Current capability (ampacity) of the cable
PWM duty cycle in percent, strictly between 0 and 100. EVerest requests 100 % (X1) and 0 % (F) through cp_state_X1 and cp_state_F instead.
Success: true, failure: false
Type of error
The ConnectorLock errors and MREC1ConnectorLockFailure are raised on the connector_lock interface, Selftest, DC and AC on ac_rcd, all others on evse_board_support. EvseManager sees connector_lock and ac_rcd errors only if its connector_lock and ac_rcd requirements are connected to this module. Only MREC3HighTemperature, MREC18CableOverTempDerate and VendorWarning let charging continue.
Errors for the evse_board_support interface. All error codes that begin with MREC needs to be implemented to fulfill the Minimum Required Error Codes defined by the ChargeX consortium: https://inl.gov/content/uploads/2023/07/ChargeX_MREC_Rev5_09.12.23.pdf
Send true at least every cfg_communication_check_to_s seconds to signal that the client is alive, otherwise EVerest raises a CommunicationFault, which the next message clears. Send false to stop the check until the module restarts.
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached