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.
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.
{
"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.
{
"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).
Example 1 of sending voltage and current.
{
"voltage_V": 230,
"current_A": 15
}
Accepts the following message:
Current mode of DC power supply.
Mode of the DC power supply
Example 1 of sending voltage and current.
Export
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Current capabilities of the DC power supply.
Capabilities example
{
"bidirectional": true,
"current_regulation_tolerance_A": 0,
"peak_current_ripple_A": 0,
"max_export_voltage_V": 0,
"min_export_voltage_V": 0,
"max_export_current_A": 0,
"min_export_current_A": 0,
"max_import_voltage_V": 0,
"min_import_voltage_V": 0,
"max_import_current_A": 0,
"min_import_current_A": 0,
"max_export_power_W": 0,
"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.
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.
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 module is alive. Send 'false' to stop communication check'
CommunicationCheck
Receive the requested mode for DC power supply and the current charging phase.
Requested Mode and the current charging state
Receive the requested voltage and current when exporting energy to the car.
Receive the requested voltage and current when importing energy from the car.
Current value of voltage (V) and current (A).
Current mode of DC power supply.
Mode of the DC power supply
Current capabilities of the DC power supply.
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.
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.
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'
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.
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