EVerest API definition for DC power supplies 1.1.0

API for EVerest API clients implementing DC power supplies.

  • #EVerest
  • #DC power supply

Servers

  • mqtt://localhost:1883/everest_api/1/power_supply_DC/{module_id}mqttdefault

    default local MQTT

    object
    module_id
    required
    string

    The ID of the module as defined in the EVerest config file.

Operations

  • RECEIVE e2m/mode

    Direction: EVerest to Module

    Operation IDreceive_mode

    Available only on servers:

    Accepts the following message:

    Receive modereceive_mode

    Receive the requested mode for DC power supply and the current charging phase.

    Message IDreceive_mode

    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.

    object

    Requested Mode and the current charging state

    Examples

  • RECEIVE e2m/export_voltage_current

    Direction: EVerest to Module

    Operation IDreceive_export_voltage_current

    Available only on servers:

    Accepts the following message:

    Receive export voltage / currentreceive_export_voltage_current

    Receive the requested voltage and current when exporting energy to the car.

    Message IDreceive_export_voltage_current

    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.

    object

    Examples

  • RECEIVE e2m/import_voltage_current

    Direction: EVerest to Module

    Operation IDreceive_import_voltage_current

    Available only on servers:

    Accepts the following message:

    Receive import voltage / currentreceive_import_voltage_current

    Receive the requested voltage and current when importing energy from the car.

    Message IDreceive_import_voltage_current

    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.

    object

    Examples

  • SEND m2e/voltage_current

    Direction: Module to EVerest

    Operation IDsend_voltage_current

    Available only on servers:

    Accepts the following message:

    Send voltage / currentsend_voltage_current

    Current value of voltage (V) and current (A).

    Message IDsend_voltage_current

    Publish at least once per second (4 Hz recommended), also when the values did not change.

    object

    Examples

  • SEND m2e/mode

    Direction: Module to EVerest

    Operation IDsend_mode

    Available only on servers:

    Accepts the following message:

    Send modesend_mode

    Current mode of DC power supply.

    Message IDsend_mode

    Informational; EVerest does not act on it.

    Payload
    string

    Mode of the DC power supply

    • Off: Power Supply switched off
    • Export: Charge the vehicle
    • Import: V2G etc
    • Fault: Power supply is in error state
      Allowed values:
    • "Off"
    • "Export"
    • "Import"
    • "Fault"

    Examples

  • SEND m2e/capabilities

    Direction: Module to EVerest

    Operation IDsend_capabilities

    Available only on servers:

    Accepts the following message:

    Send current capabilitiessend_capabilities

    Current capabilities of the DC power supply. Non-nominal values can be used to update the limits during runtime, e.g. for derating.

    Message IDsend_capabilities
    object

    Examples

  • SEND m2e/raise_error

    Direction: Module to EVerest

    Operation IDsend_raise_error

    Available only on servers:

    Accepts the following message:

    Send raise errorsend_raise_error

    Signal to EVerest that an error happened.

    Message IDsend_raise_error
    object

    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.

    Examples

  • SEND m2e/clear_error

    Operation IDsend_clear_error

    Available only on servers:

    Accepts the following message:

    Send clear errorsend_clear_error

    Signal to EVerest that a previously raised error is no longer active.

    Message IDsend_clear_error
    object

    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.

    Examples

  • RECEIVE e2m/heartbeat

    Direction: EVerest to Module

    Operation IDreceive_heartbeat

    Available only on servers:

    Accepts the following message:

    Receive heartbeatreceive_heartbeat

    Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration

    Message IDreceive_heartbeat
    Payload
    integer

    64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

    Examples

  • SEND m2e/communication_check

    Operation IDsend_communication_check

    Available only on servers:

    Accepts the following message:

    Send communication checksend_communication_check

    Signal to EVerest that communication is good or check shall be stopped

    Message IDsend_communication_check
    Payload
    boolean

    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.

    Examples

Messages

  • #1Receive modereceive_mode

    Receive the requested mode for DC power supply and the current charging phase.

    Message IDreceive_mode

    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.

    object

    Requested Mode and the current charging state

  • #2Receive export voltage / currentreceive_export_voltage_current

    Receive the requested voltage and current when exporting energy to the car.

    Message IDreceive_export_voltage_current

    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.

    object
  • #3Receive import voltage / currentreceive_import_voltage_current

    Receive the requested voltage and current when importing energy from the car.

    Message IDreceive_import_voltage_current

    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.

    object
  • #4Send voltage / currentsend_voltage_current

    Current value of voltage (V) and current (A).

    Message IDsend_voltage_current

    Publish at least once per second (4 Hz recommended), also when the values did not change.

    object
  • #5Send modesend_mode

    Current mode of DC power supply.

    Message IDsend_mode

    Informational; EVerest does not act on it.

    Payload
    string

    Mode of the DC power supply

    • Off: Power Supply switched off
    • Export: Charge the vehicle
    • Import: V2G etc
    • Fault: Power supply is in error state
      Allowed values:
    • "Off"
    • "Export"
    • "Import"
    • "Fault"
  • #6Send current capabilitiessend_capabilities

    Current capabilities of the DC power supply. Non-nominal values can be used to update the limits during runtime, e.g. for derating.

    Message IDsend_capabilities
    object
  • #7Send raise errorsend_raise_error

    Signal to EVerest that an error happened.

    Message IDsend_raise_error
    object

    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.

  • #8Send clear errorsend_clear_error

    Signal to EVerest that a previously raised error is no longer active.

    Message IDsend_clear_error
    object

    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.

  • #9Receive heartbeatreceive_heartbeat

    Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration

    Message IDreceive_heartbeat
    Payload
    integer

    64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

  • #10Send communication checksend_communication_check

    Signal to EVerest that communication is good or check shall be stopped

    Message IDsend_communication_check
    Payload
    boolean

    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.

Schemas

  • object
  • ChargingPhase
    string

    Charging phase of the current mode change.

    • Other: Used for e.g. switching it off or any other internal testing not related to real charging.
    • CableCheck
    • PreCharge
    • Charging
      Allowed values:
    • "Other"
    • "CableCheck"
    • "PreCharge"
    • "Charging"
  • Mode
    string

    Mode of the DC power supply

    • Off: Power Supply switched off
    • Export: Charge the vehicle
    • Import: V2G etc
    • Fault: Power supply is in error state
      Allowed values:
    • "Off"
    • "Export"
    • "Import"
    • "Fault"
  • object

    Requested Mode and the current charging state

  • object
  • ErrorEnum
    string

    Type of error

    • CommunicationFault: The communication to the hardware or underlying driver is lost or has errors.
    • HardwareFault: The hardware reported a fault
    • OverTemperature: The hardware shut down because of over temperature. This should not be used if the power supply can handle temperature reduction by reducing output power, in this case update the capabilities as needed.
    • UnderTemperature: The hardware cannot operate because it is too cold
    • UnderVoltageAC: The AC input voltage is too low
    • OverVoltageAC: The AC input voltage is too high
    • UnderVoltageDC: The DC output voltage is too low
    • OverVoltageDC: The DC output voltage is too high
    • OverCurrentAC: The AC input current is too high
    • OverCurrentDC: The DC output current it too high
    • VendorError: Vendor specific error code. Will stop charging session.
    • VendorWarning: Vendor specific error code. Charging may continue.
      Allowed values:
    • "CommunicationFault"
    • "HardwareFault"
    • "OverTemperature"
    • "UnderTemperature"
    • "UnderVoltageAC"
    • "OverVoltageAC"
    • "UnderVoltageDC"
    • "OverVoltageDC"
    • "OverCurrentAC"
    • "OverCurrentDC"
    • "VendorError"
    • "VendorWarning"
  • object

    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.

  • CommunicationCheck
    boolean

    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.

  • HeartBeatId
    integer

    64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached