API for EVerest API clients implementing DC power supplies.
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:
Receive the requested mode for DC power supply and the current charging phase.
A session usually requests Export with charging_phase CableCheck, then PreCharge, then Charging, but do not rely on a fixed sequence. Export can arrive while the output is already on, only to announce a new charging_phase: keep the output on. Off can arrive between phases and ends the session. After Off, bring the output voltage down: after CableCheck, EVerest waits at most 10 s for it to drop below 60 V. Import replaces Export while energy flows from the car. After Off, a new setpoint arrives before the next Export.
Requested Mode and the current charging state
{
"mode": "Off",
"charging_phase": "Other"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Receive the requested voltage and current when exporting energy to the car.
When EVerest switches the output on, the setpoint arrives before the Export mode request. When the output is already on and only the charging phase changes, the mode request arrives first. During CableCheck EVerest requests 2 A, during PreCharge at least 2 A. If the measured voltage does not come within 10 V of the CableCheck setpoint within 10 s, the cable check fails. A current below min_export_current_A, including 0 A, means: deliver no current (0 A, +/- 0.15 A, IEC 61851-23:2023 CC.5.5.2). Do not raise it to the minimum. If the hardware cannot regulate to 0 A, switch its output off, keep the mode, and switch it on again when a current at or above the minimum is requested.
{
"voltage_V": 0,
"current_A": 0
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Receive the requested voltage and current when importing energy from the car.
A current below min_import_current_A, including 0 A, means: deliver no current (0 A, +/- 0.15 A, IEC 61851-23:2023 CC.5.5.2). Do not raise it to the minimum. If the hardware cannot regulate to 0 A, switch its output off, keep the mode, and switch it on again when a current at or above the minimum is requested.
{
"voltage_V": 0,
"current_A": 0
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Current value of voltage (V) and current (A).
Publish at least once per second (4 Hz recommended), also when the values did not change.
Example 1 of sending voltage and current.
{
"voltage_V": 230,
"current_A": 15
}
Accepts the following message:
Current mode of DC power supply.
Informational; EVerest does not act on it.
Mode of the DC power supply
Example of sending mode.
Export
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Current capabilities of the DC power supply. Non-nominal values can be used to update the limits during runtime, e.g. for derating.
Capabilities example
{
"bidirectional": true,
"current_regulation_tolerance_A": 0,
"peak_current_ripple_A": 0,
"max_export_voltage_V": 0,
"nominal_max_export_voltage_V": 0,
"min_export_voltage_V": 0,
"nominal_min_export_voltage_V": 0,
"max_export_current_A": 0,
"nominal_max_export_current_A": 0,
"min_export_current_A": 0,
"nominal_min_export_current_A": 0,
"max_import_voltage_V": 0,
"nominal_max_import_voltage_V": 0,
"min_import_voltage_V": 0,
"nominal_min_import_voltage_V": 0,
"max_import_current_A": 0,
"nominal_max_import_current_A": 0,
"min_import_current_A": 0,
"nominal_min_import_current_A": 0,
"max_export_power_W": 0,
"nominal_max_export_power_W": 0,
"max_import_power_W": 0,
"nominal_max_import_power_W": 0,
"conversion_efficiency_import": 1,
"conversion_efficiency_export": 1
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Signal to EVerest that an error happened.
Errors for the power_supply_DC interface. Except for VendorWarning, all error codes will stop the charging session. During all errors, follow the commands for setMode and setVoltageCurrent from EvseManager. If they cannot be sent to the hardware, cache the last values received. Once the PSU is back on-line (e.g. after a CommunicationFault), set the last mode and voltage/current values and only after that clear the error. clear_error must repeat the type and sub_type of the raise.
Raise error example
{
"type": "CommunicationFault",
"sub_type": "string",
"message": "string"
}
Accepts the following message:
Signal to EVerest that a previously raised error is no longer active.
Errors for the power_supply_DC interface. Except for VendorWarning, all error codes will stop the charging session. During all errors, follow the commands for setMode and setVoltageCurrent from EvseManager. If they cannot be sent to the hardware, cache the last values received. Once the PSU is back on-line (e.g. after a CommunicationFault), set the last mode and voltage/current values and only after that clear the error. clear_error must repeat the type and sub_type of the raise.
Raise error example
{
"type": "CommunicationFault",
"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.
CommunicationCheck
Receive the requested mode for DC power supply and the current charging phase.
A session usually requests Export with charging_phase CableCheck, then PreCharge, then Charging, but do not rely on a fixed sequence. Export can arrive while the output is already on, only to announce a new charging_phase: keep the output on. Off can arrive between phases and ends the session. After Off, bring the output voltage down: after CableCheck, EVerest waits at most 10 s for it to drop below 60 V. Import replaces Export while energy flows from the car. After Off, a new setpoint arrives before the next Export.
Requested Mode and the current charging state
Receive the requested voltage and current when exporting energy to the car.
When EVerest switches the output on, the setpoint arrives before the Export mode request. When the output is already on and only the charging phase changes, the mode request arrives first. During CableCheck EVerest requests 2 A, during PreCharge at least 2 A. If the measured voltage does not come within 10 V of the CableCheck setpoint within 10 s, the cable check fails. A current below min_export_current_A, including 0 A, means: deliver no current (0 A, +/- 0.15 A, IEC 61851-23:2023 CC.5.5.2). Do not raise it to the minimum. If the hardware cannot regulate to 0 A, switch its output off, keep the mode, and switch it on again when a current at or above the minimum is requested.
Receive the requested voltage and current when importing energy from the car.
A current below min_import_current_A, including 0 A, means: deliver no current (0 A, +/- 0.15 A, IEC 61851-23:2023 CC.5.5.2). Do not raise it to the minimum. If the hardware cannot regulate to 0 A, switch its output off, keep the mode, and switch it on again when a current at or above the minimum is requested.
Current value of voltage (V) and current (A).
Publish at least once per second (4 Hz recommended), also when the values did not change.
Current mode of DC power supply.
Informational; EVerest does not act on it.
Mode of the DC power supply
Current capabilities of the DC power supply. Non-nominal values can be used to update the limits during runtime, e.g. for derating.
Signal to EVerest that an error happened.
Errors for the power_supply_DC interface. Except for VendorWarning, all error codes will stop the charging session. During all errors, follow the commands for setMode and setVoltageCurrent from EvseManager. If they cannot be sent to the hardware, cache the last values received. Once the PSU is back on-line (e.g. after a CommunicationFault), set the last mode and voltage/current values and only after that clear the error. clear_error must repeat the type and sub_type of the raise.
Signal to EVerest that a previously raised error is no longer active.
Errors for the power_supply_DC interface. Except for VendorWarning, all error codes will stop the charging session. During all errors, follow the commands for setMode and setVoltageCurrent from EvseManager. If they cannot be sent to the hardware, cache the last values received. Once the PSU is back on-line (e.g. after a CommunicationFault), set the last mode and voltage/current values and only after that clear the error. clear_error must repeat the type and sub_type of the raise.
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.
Charging phase of the current mode change.
Mode of the DC power supply
Requested Mode and the current charging state
Type of error
Errors for the power_supply_DC interface. Except for VendorWarning, all error codes will stop the charging session. During all errors, follow the commands for setMode and setVoltageCurrent from EvseManager. If they cannot be sent to the hardware, cache the last values received. Once the PSU is back on-line (e.g. after a CommunicationFault), set the last mode and voltage/current values and only after that clear the error. clear_error must repeat the type and sub_type of the raise.
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