API for EVerest API clients implementing ev board support.
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 EV simulation.
True: enabled. False: disabled.
Enable the EV.
true
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Receive the CP State that should be set by the EV board support driver (controlled by S2)
ControlPilot state
Set the CP state to A.
A
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
If false, contactor must never be switched on.
True: allow power on, false: do not allow power on.
Allow the relays to be closed.
true
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
If true, simulator should set a diode failure.
True: Diode failure, false: no failure.
Diode failure signaled
true
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Maximum AC current to be requested from the EV.
Max current requested from the EV.
EV should request 16A maximum
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Wether the EV should indicate single or three phase support.
True: Three phase support, False: One phase support.
EV should request single phase only.
false
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Setting a rcd error. Only for simulation purpose.
RCD current in mA.
EV should request single phase only.
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Events from CP/Relais
Event stream from ControlPilot signal/relais.
Signal state A (not connected)
{
"event": "A"
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Instantaneous BSP measurements
Bsp Measurement
Report cable ampicity of 32A and some RCD current + PWM duty cycle
{
"proximity_pilot": {
"ampacity": "A_32"
},
"rcd_current_mA": 5,
"cp_pwm_duty_cycle": 53
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Details about the EV if available
Information about the connected EV if available
Selection of EV information items.
{
"soc": 67,
"present_voltage": 390,
"present_current": 80,
"target_voltage": 420,
"target_current": 80,
"maximum_current_limit": 120,
"minimum_current_limit": 10,
"maximum_voltage_limit": 500,
"evcc_id": "aa:bb:cc:dd:ee:ff",
"battery_capacity": 77000,
"battery_full_soc": 95
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Signal to EVerest that an error happened.
Error object with type, subtype and message.
{
"type": "VendorError",
"sub_type": "string",
"message": "string"
}
Accepts the following message:
Signal to EVerest that a previously raised error is no longer active.
Error object with type, subtype and message.
{
"type": "VendorError",
"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 module is alive. Send 'false' to stop communication check'
true
Enables or disables the EV simulation.
True: enabled. False: disabled.
Receive the CP State that should be set by the EV board support driver (controlled by S2)
ControlPilot state
If false, contactor must never be switched on.
True: allow power on, false: do not allow power on.
If true, simulator should set a diode failure.
True: Diode failure, false: no failure.
Maximum AC current to be requested from the EV.
Max current requested from the EV.
Wether the EV should indicate single or three phase support.
True: Three phase support, False: One phase support.
Setting a rcd error. Only for simulation purpose.
RCD current in mA.
Events from CP/Relais
Event stream from ControlPilot signal/relais.
Instantaneous BSP measurements
Bsp Measurement
Details about the EV if available
Information about the connected EV if available
Signal to EVerest that an error happened.
Error object with type, subtype and message.
Signal to EVerest that a previously raised error is no longer active.
Error object with type, subtype and 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
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 module is alive. Send 'false' to stop communication check'
True: enabled. False: disabled.
ControlPilot state
True: allow power on, false: do not allow power on.
True: Diode failure, false: no failure.
Max current requested from the EV.
True: Three phase support, False: One phase support.
RCD current in mA.
Bsp Measurement
Type of error
Error object with type, subtype and message.
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached