EVerest API definition for the use of the EVSE manager 1.0.0

API to allow EVerest API clients to use the EvseManager module.

  • #EVerest
  • #EVSE manager

Servers

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

    default local MQTT

    object
    module_id
    required
    string

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

Operations

  • REQUEST m2e/get_evse

    Direction: Module to EVerest

    Operation IDsend_request_get_evse

    Available only on servers:

    Accepts the following message:

    Request to get EVSEsend_request_get_evse

    Request to get EVSE.

    Message IDsend_request_get_evse
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be directed to the address specified at this location: $message.header#/replyTo

    REPLY address information

    REPLY will be sent to the address provided in:$message.header#/replyTo

  • RECEIVE

    Operation IDreceive_reply_get_evse

    Available only on servers:

    Accepts the following message:

    Reply to request to get EVSEreceive_reply_get_evse

    Reply to the request to get the EVSE.

    Message IDreceive_reply_get_evse
    object

    Type that defines properties of an EVSE including its connectors

    Examples

  • REQUEST m2e/enable_disable

    Direction: Module to EVerest

    Operation IDsend_request_enable_disable

    Available only on servers:

    Accepts the following message:

    Request to enable or disable the EVSEsend_request_enable_disable

    Enables or disables the evse. Turns off PWM with error F. Charging is only possible if an EVSE is enabled.

    Message IDsend_request_enable_disable
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be directed to the address specified at this location: $message.header#/replyTo

    REPLY address information

    REPLY will be sent to the address provided in:$message.header#/replyTo

  • RECEIVE

    Operation IDreceive_reply_enable_disable

    Available only on servers:

    Accepts the following message:

    Reply to request to enable or disable the EVSEreceive_reply_enable_disable

    Reply to the request to enable or disable the EVSE.

    Message IDreceive_reply_enable_disable
    Payload
    boolean

    Returns true if evse is enabled after the command, false if it is disabled. This may not be the same value as the request, since there may be a higher priority request from another source that is actually deciding whether it is enabled or disabled.

    Examples

  • REQUEST m2e/pause_charging

    Direction: Module to EVerest

    Operation IDsend_request_pause_charging

    Available only on servers:

    Accepts the following message:

    Request pause chargingsend_request_pause_charging

    Request to pause charging.

    Message IDsend_request_pause_charging
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be directed to the address specified at this location: $message.header#/replyTo

    REPLY address information

    REPLY will be sent to the address provided in:$message.header#/replyTo

  • RECEIVE

    Operation IDreceive_reply_pause_charging

    Available only on servers:

    Accepts the following message:

    Reply to pause charging requestreceive_reply_pause_charging

    Reply to the request to pause charging.

    Message IDreceive_reply_pause_charging
    Payload
    boolean

    Reply to pause charging request. 'true' on success

    Examples

  • REQUEST m2e/resume_charging

    Direction: Module to EVerest

    Operation IDsend_request_resume_charging

    Available only on servers:

    Accepts the following message:

    Request resume chargingsend_request_resume_charging

    Request to resume charging.

    Message IDsend_request_resume_charging
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be directed to the address specified at this location: $message.header#/replyTo

    REPLY address information

    REPLY will be sent to the address provided in:$message.header#/replyTo

  • RECEIVE

    Operation IDreceive_reply_resume_charging

    Available only on servers:

    Accepts the following message:

    Reply to resume charging requestreceive_reply_resume_charging

    Reply to the request to resume charging.

    Message IDreceive_reply_resume_charging
    Payload
    boolean

    Reply to resume charging request. 'true' on success, false otherwise (e.g. resuming a car pause won't work)

    Examples

  • REQUEST m2e/stop_transaction

    Direction: Module to EVerest

    Operation IDsend_request_stop_transaction

    Available only on servers:

    Accepts the following message:

    Request stop transactionsend_request_stop_transaction

    Request to stop the current transaction.

    Message IDsend_request_stop_transaction
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be directed to the address specified at this location: $message.header#/replyTo

    REPLY address information

    REPLY will be sent to the address provided in:$message.header#/replyTo

  • RECEIVE

    Operation IDreceive_reply_stop_transaction

    Available only on servers:

    Accepts the following message:

    Reply to stop transaction requestreceive_reply_stop_transaction

    Reply to the request to stop the current transaction.

    Message IDreceive_reply_stop_transaction
    Payload
    boolean

    Reply to stop transaction request. 'true' on success

    Examples

  • REQUEST m2e/force_unlock

    Direction: Module to EVerest

    Operation IDsend_request_force_unlock

    Available only on servers:

    Accepts the following message:

    Request force unlocksend_request_force_unlock

    Request to force unlock.

    Message IDsend_request_force_unlock
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be directed to the address specified at this location: $message.header#/replyTo

    REPLY address information

    REPLY will be sent to the address provided in:$message.header#/replyTo

  • RECEIVE

    Operation IDreceive_reply_force_unlock

    Available only on servers:

    Accepts the following message:

    Reply to force unlock requestreceive_reply_force_unlock

    Forces connector to unlock connector now. During normal operation, connector will be locked/unlocked in the correct sequence.Do not use this function except if explicitly requested by e.g. management cloud.

    Message IDreceive_reply_force_unlock
    Payload
    boolean

    Returns true if unlocking sequence was successfully executed

    Examples

  • RECEIVE e2m/session_event

    Operation IDreceive_session_event

    Available only on servers:

    Accepts the following message:

    Receive session eventreceive_session_event

    Emits all events related to sessions

    Message IDreceive_session_event
    object

    Emits all events related to sessions

    Examples

  • RECEIVE e2m/ev_info

    Operation IDreceive_ev_info

    Available only on servers:

    Accepts the following message:

    Receive details about EVreceive_ev_info

    More details about the EV if available.

    Message IDreceive_ev_info
    object

    Information about the connected EV if available

    Examples

  • RECEIVE e2m/session_info

    Operation IDreceive_session_info

    Available only on servers:

    Accepts the following message:

    Receive session and transaction informationreceive_session_info

    Information about the current session and transaction. During a session, data is published with a frequency of ~1Hz. If no session is active, data is published on change. A session starts when the first user interaction occurs, e.g. plug in of an EV or authorization was provided. A session ends when the EV is unplugged or the authorization has timed out. A transaction starts if an EV is plugged in and the user is authorized. A transaction ends when the EV is unplugged or the user is not authorized anymore.

    Message IDreceive_session_info
    object

    Context for Session information

    Examples

  • RECEIVE e2m/powermeter

    Operation IDreceive_powermeter

    Available only on servers:

    Accepts the following message:

    Receive powermeterreceive_powermeter

    Powermeter measured dataset

    Message IDreceive_powermeter
    object

    Measured dataset (AC or DC)

    Examples

  • RECEIVE e2m/powermeter_public_key_ocmf

    Operation IDreceive_powermeter_public_key_ocmf

    Available only on servers:

    Accepts the following message:

    Receive powermeter public key OCMFreceive_powermeter_public_key_ocmf

    Powermeter public key OCMF

    Message IDreceive_powermeter_public_key_ocmf
    Payload
    string

    The public key as string used to sign the OCMF data

    Examples

  • RECEIVE e2m/evse_id

    Operation IDreceive_evse_id

    Available only on servers:

    Accepts the following message:

    Receive EVSE IDreceive_evse_id

    EVSE ID

    Message IDreceive_evse_id
    Payload
    string

    EVSE ID including the connector number, e.g. DEPNXE123456*1

    Examples

  • RECEIVE e2m/hw_capabilities

    Operation IDreceive_hw_capabilities

    Available only on servers:

    Accepts the following message:

    Receive hardware capabilities and limitsreceive_hw_capabilities

    Hardware capabilities

    Message IDreceive_hw_capabilities
    object

    Hardware capabilities / limits

    Examples

  • RECEIVE e2m/enforced_limits

    Operation IDreceive_enforced_limits

    Available only on servers:

    Accepts the following message:

    Receive enforced limitsreceive_enforced_limits

    Enforced limits for this node (coming from the EnergyManager)

    Message IDreceive_enforced_limits
    object

    Enforce Limits data type

    Examples

  • RECEIVE e2m/selected_protocol

    Operation IDreceive_selected_protocol

    Available only on servers:

    Accepts the following message:

    Receive selected protocol for charging for informative purposesreceive_selected_protocol

    EVSE ID

    Message IDreceive_selected_protocol
    Payload
    string

    The selected protocol for charging

    Examples

  • RECEIVE e2m/supported_energy_transfer_modes

    Operation IDreceive_supported_energy_transfer_modes

    Available only on servers:

    Accepts the following message:

    Receive supported energy transfer modesreceive_supported_energy_transfer_modes

    The list of supported energy transfers e.g. AC mono/tri, DC, DC_BPT, etc.

    Message IDreceive_supported_energy_transfer_modes
    array<string>
    non-empty

    List of supported energy transfers e.g. AC mono/tri, DC, DC_BPT, etc.

    Examples

  • RECEIVE e2m/ac_nr_of_phases_available

    Operation IDreceive_ac_nr_of_phases_available

    Available only on servers:

    Accepts the following message:

    Receive Instantaneous phase count available to carreceive_ac_nr_of_phases_available

    Number of phases for AC

    Message IDreceive_ac_nr_of_phases_available
    Payload
    integer
    [ 1 .. 3 ]

    Number of phases

    Examples

  • RECEIVE e2m/ac_pp_ampacity

    Operation IDreceive_ac_pp_ampacity

    Available only on servers:

    Accepts the following message:

    Receive current carrying capacity of the connected cable in ampere for AC chargingreceive_ac_pp_ampacity

    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.

    Message IDreceive_ac_pp_ampacity
    object

    Current capability (ampacity) of the cable

    Examples

  • RECEIVE e2m/isolation_measurement

    Operation IDreceive_isolation_measurement

    Available only on servers:

    Accepts the following message:

    Receive isolation monitoring measurement resultsreceive_isolation_measurement

    Receive isolation monitoring measurement results

    Message IDreceive_isolation_measurement
    object

    Results of an isolation measurement

    Examples

  • RECEIVE e2m/dc_voltage_current

    Operation IDreceive_dc_voltage_current

    Available only on servers:

    Accepts the following message:

    Receive Voltage/Current at the input/outputreceive_dc_voltage_current

    Receive Voltage/Current at the input/output

    Message IDreceive_dc_voltage_current
    object

    Examples

  • RECEIVE e2m/dc_mode

    Operation IDreceive_dc_mode

    Available only on servers:

    Accepts the following message:

    Receive the current modereceive_dc_mode

    Receive the current mode of the DC power supply

    Message IDreceive_dc_mode
    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

  • RECEIVE e2m/dc_capabilities

    Operation IDreceive_dc_capabilities

    Available only on servers:

    Accepts the following message:

    Receive the capabilities of the DC power supplyreceive_dc_capabilities

    Receive the capabilities of the DC power supply

    Message IDreceive_dc_capabilities
    object

    Examples

  • SEND m2e/random_delay_enable

    Operation IDsend_random_delay_enable

    Available only on servers:

    Accepts the following message:

    Send random delay enablesend_random_delay_enable

    Call to enable the random delay feature

    Message IDsend_random_delay_enable

    Examples

  • SEND m2e/random_delay_disable

    Operation IDsend_random_delay_disable

    Available only on servers:

    Accepts the following message:

    Send random delay disablesend_random_delay_disable

    Call to disable the random delay feature

    Message IDsend_random_delay_disable

    Examples

  • SEND m2e/random_delay_cancel

    Operation IDsend_random_delay_cancel

    Available only on servers:

    Accepts the following message:

    Send random delay cancelsend_random_delay_enable

    Cancels a running random delay. The effect is the same as if the time expired just now.

    Message IDsend_random_delay_enable

    Examples

  • SEND m2e/random_delay_set_duration_s

    Operation IDsend_random_delay_set_duration_s

    Available only on servers:

    Accepts the following message:

    Send random delay set durationsend_random_delay_set_duration_s

    Set the maximum duration of the random delay. Default is 600 seconds.

    Message IDsend_random_delay_set_duration_s
    Payload
    integer

    Maximum duration in seconds

    Examples

  • RECEIVE e2m/random_delay_countdown

    Operation IDreceive_random_delay_countdown

    Available only on servers:

    Accepts the following message:

    Countdown of the currently running random delayreceive_random_delay_countdown

    Random delay countdown

    Message IDreceive_random_delay_countdown
    object

    Count down object

    Examples

  • RECEIVE e2m/heartbeat

    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 module is alive. Send 'false' to stop communication check'

    Examples

Messages

  • #1Request to get EVSEsend_request_get_evse

    Request to get EVSE.

    Message IDsend_request_get_evse
    object
  • #2Reply to request to get EVSEreceive_reply_get_evse

    Reply to the request to get the EVSE.

    Message IDreceive_reply_get_evse
    object

    Type that defines properties of an EVSE including its connectors

  • #3Request to enable or disable the EVSEsend_request_enable_disable

    Enables or disables the evse. Turns off PWM with error F. Charging is only possible if an EVSE is enabled.

    Message IDsend_request_enable_disable
    object
  • #4Reply to request to enable or disable the EVSEreceive_reply_enable_disable

    Reply to the request to enable or disable the EVSE.

    Message IDreceive_reply_enable_disable
    Payload
    boolean

    Returns true if evse is enabled after the command, false if it is disabled. This may not be the same value as the request, since there may be a higher priority request from another source that is actually deciding whether it is enabled or disabled.

  • #5Request pause chargingsend_request_pause_charging

    Request to pause charging.

    Message IDsend_request_pause_charging
    object
  • #6Reply to pause charging requestreceive_reply_pause_charging

    Reply to the request to pause charging.

    Message IDreceive_reply_pause_charging
    Payload
    boolean

    Reply to pause charging request. 'true' on success

  • #7Request resume chargingsend_request_resume_charging

    Request to resume charging.

    Message IDsend_request_resume_charging
    object
  • #8Reply to resume charging requestreceive_reply_resume_charging

    Reply to the request to resume charging.

    Message IDreceive_reply_resume_charging
    Payload
    boolean

    Reply to resume charging request. 'true' on success, false otherwise (e.g. resuming a car pause won't work)

  • #9Request stop transactionsend_request_stop_transaction

    Request to stop the current transaction.

    Message IDsend_request_stop_transaction
    object
  • #10Reply to stop transaction requestreceive_reply_stop_transaction

    Reply to the request to stop the current transaction.

    Message IDreceive_reply_stop_transaction
    Payload
    boolean

    Reply to stop transaction request. 'true' on success

  • #11Request force unlocksend_request_force_unlock

    Request to force unlock.

    Message IDsend_request_force_unlock
    object
  • #12Reply to force unlock requestreceive_reply_force_unlock

    Forces connector to unlock connector now. During normal operation, connector will be locked/unlocked in the correct sequence.Do not use this function except if explicitly requested by e.g. management cloud.

    Message IDreceive_reply_force_unlock
    Payload
    boolean

    Returns true if unlocking sequence was successfully executed

  • #13Receive session eventreceive_session_event

    Emits all events related to sessions

    Message IDreceive_session_event
    object

    Emits all events related to sessions

  • #14Receive details about EVreceive_ev_info

    More details about the EV if available.

    Message IDreceive_ev_info
    object

    Information about the connected EV if available

  • #15Receive session and transaction informationreceive_session_info

    Information about the current session and transaction. During a session, data is published with a frequency of ~1Hz. If no session is active, data is published on change. A session starts when the first user interaction occurs, e.g. plug in of an EV or authorization was provided. A session ends when the EV is unplugged or the authorization has timed out. A transaction starts if an EV is plugged in and the user is authorized. A transaction ends when the EV is unplugged or the user is not authorized anymore.

    Message IDreceive_session_info
    object

    Context for Session information

  • #16Receive powermeterreceive_powermeter

    Powermeter measured dataset

    Message IDreceive_powermeter
    object

    Measured dataset (AC or DC)

  • #17Receive powermeter public key OCMFreceive_powermeter_public_key_ocmf

    Powermeter public key OCMF

    Message IDreceive_powermeter_public_key_ocmf
    Payload
    string

    The public key as string used to sign the OCMF data

  • #18Receive EVSE IDreceive_evse_id

    EVSE ID

    Message IDreceive_evse_id
    Payload
    string

    EVSE ID including the connector number, e.g. DEPNXE123456*1

  • #19Receive hardware capabilities and limitsreceive_hw_capabilities

    Hardware capabilities

    Message IDreceive_hw_capabilities
    object

    Hardware capabilities / limits

  • #20Receive enforced limitsreceive_enforced_limits

    Enforced limits for this node (coming from the EnergyManager)

    Message IDreceive_enforced_limits
    object

    Enforce Limits data type

  • #21Receive selected protocol for charging for informative purposesreceive_selected_protocol

    EVSE ID

    Message IDreceive_selected_protocol
    Payload
    string

    The selected protocol for charging

  • #22Receive supported energy transfer modesreceive_supported_energy_transfer_modes

    The list of supported energy transfers e.g. AC mono/tri, DC, DC_BPT, etc.

    Message IDreceive_supported_energy_transfer_modes
    array<string>
    non-empty

    List of supported energy transfers e.g. AC mono/tri, DC, DC_BPT, etc.

  • #23Receive Instantaneous phase count available to carreceive_ac_nr_of_phases_available

    Number of phases for AC

    Message IDreceive_ac_nr_of_phases_available
    Payload
    integer
    [ 1 .. 3 ]

    Number of phases

  • #24Receive current carrying capacity of the connected cable in ampere for AC chargingreceive_ac_pp_ampacity

    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.

    Message IDreceive_ac_pp_ampacity
    object

    Current capability (ampacity) of the cable

  • #26Receive isolation monitoring measurement resultsreceive_isolation_measurement

    Receive isolation monitoring measurement results

    Message IDreceive_isolation_measurement
    object

    Results of an isolation measurement

  • #27Receive Voltage/Current at the input/outputreceive_dc_voltage_current

    Receive Voltage/Current at the input/output

    Message IDreceive_dc_voltage_current
    object
  • #28Receive the current modereceive_dc_mode

    Receive the current mode of the DC power supply

    Message IDreceive_dc_mode
    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"
  • #29Receive the capabilities of the DC power supplyreceive_dc_capabilities

    Receive the capabilities of the DC power supply

    Message IDreceive_dc_capabilities
    object
  • #30Send random delay enablesend_random_delay_enable

    Call to enable the random delay feature

    Message IDsend_random_delay_enable
  • #31Send random delay disablesend_random_delay_disable

    Call to disable the random delay feature

    Message IDsend_random_delay_disable
  • #32Send random delay cancelsend_random_delay_cancel

    Cancels a running random delay. The effect is the same as if the time expired just now.

    Message IDsend_random_delay_cancel
  • #33Send random delay set durationsend_random_delay_set_duration_s

    Set the maximum duration of the random delay. Default is 600 seconds.

    Message IDsend_random_delay_set_duration_s
    Payload
    integer

    Maximum duration in seconds

  • #34Countdown of the currently running random delayreceive_random_delay_countdown

    Random delay countdown

    Message IDreceive_random_delay_countdown
    object

    Count down object

  • #35Receive 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

  • #36Send 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 module is alive. Send 'false' to stop communication check'

Schemas

  • object

    Context for authorization event (Authorized or Deauthorized)

  • EvseStateEnum
    string

    State of the EVSE:

    • Unknown: Initial state when state is not known
    • Unplugged: No EV is connected
    • Disabled: EVSE is disabled on not available for energy transfer
    • Preparing: First user interaction occured, e.g. plug in of EV or authorization has been received
    • AuthRequired: EV is plugged in and EVSE is waiting for authorization
    • WaitingForEnergy: EVSE is waiting for energy. Occurs at the start of the session or when no energy is available
    • ChargingPausedEV: Session is paused by EV
    • ChargingPausedEVSE: Session is paused by EVSE
    • Charging: EV is charging
    • AuthTimeout: EV has been plugged in but no authorization has been provided. A replug is required.
    • Finished: Transaction is finished
    • FinishedEVSE: Stop of transaction was initiated by EVSE e.g. by user request
    • FinishedEV: Stopping of transaction was initiated by EV
      Allowed values:
    • "Unknown"
    • "Unplugged"
    • "Disabled"
    • "Preparing"
    • "Reserved"
    • "AuthRequired"
    • "WaitingForEnergy"
    • "ChargingPausedEV"
    • "ChargingPausedEVSE"
    • "Charging"
    • "AuthTimeout"
    • "Finished"
    • "FinishedEVSE"
    • "FinishedEV"
  • object

    Context for Session information

  • object

    Context for ChargingStateChanged event

  • object

    Type for a connector which is an independently operated and managed electrical outlet of an EVSE. It corresponds to a single physical connector

  • ConnectorTypeEnum
    string

    Type of a physical connector

    • cCCS1: Combined Charging System 1 a.k.a. Combo 1
    • cCCS2: Combined Charging System 2 a.k.a. Combo 2
    • cG105: JARI G105-1993 a.k.a. CHAdeMO
    • cTesla: Tesla Connector
    • cType1: IEC62196-2 Type 1 connector a.k.a. J1772
    • cType2: IEC62196-2 Type 2 connector a.k.a. Mennekes connector
    • s309_1P_16A: 16A 1 phase IEC60309 socket
    • s309_1P_32A: 32A 1 phase IEC60309 socket
    • s309_3P_16A: 16A 3 phase IEC60309 socket
    • s309_3P_32A: 32A 3 phase IEC60309 socket
    • sBS1361: UK domestic socket a.k.a. 13Amp
    • sCEE-7_7: CEE 7/7 16A socket a.k.a Schuko
    • sType2: IEC62196-2 Type 2 socket a.k.a. Mennekes connector
    • sType3: IEC62196-2 Type 2 socket a.k.a. Scame
    • Other1PhMax16A: Other single phase (domestic) sockets not mentioned above, rated at no more than 16A. CEE7/17, AS3112, NEMA 5-15, NEMA 5-20, JISC8303, TIS166, SI 32, CPCS-CCC, SEV1011, etc
    • Other1PhOver16A: Other single phase sockets not mentioned above (over 16A)
    • Other3Ph: Other 3 phase sockets not mentioned above. NEMA14-30, NEMA14-50.
    • Pan: Pantograph connector
    • wInductive: Wireless inductively coupled connection (generic)
    • wResonant: Wireless resonant coupled connection (generic)
    • Undetermined: Yet to be determined (e.g. before plugged in)
    • Unknown: Unknown
      Allowed values:
    • "cCCS1"
    • "cCCS2"
    • "cG105"
    • "cTesla"
    • "cType1"
    • "cType2"
    • "s309_1P_16A"
    • "s309_1P_32A"
    • "s309_3P_16A"
    • "s309_3P_32A"
    • "sBS1361"
    • "sCEE_7_7"
    • "sType2"
    • "sType3"
    • "Other1PhMax16A"
    • "Other1PhOver16A"
    • "Other3Ph"
    • "Pan"
    • "wInductive"
    • "wResonant"
    • "Undetermined"
    • "Unknown"
  • object

    Count down object

  • EnableDisableReply
    boolean

    Returns true if evse is enabled after the command, false if it is disabled. This may not be the same value as the request, since there may be a higher priority request from another source that is actually deciding whether it is enabled or disabled.

  • object

    Arguments for enable_disable

  • object

    Source of a Enable or Disable command/event

  • object

    Enforce Limits data type

  • array<string>
    non-empty

    List of supported energy transfers e.g. AC mono/tri, DC, DC_BPT, etc.

  • object

    Type that defines properties of an EVSE including its connectors

  • EvseId
    string

    EVSE ID including the connector number, e.g. DEPNXE123456*1

  • object

    Information about the connected EV if available

  • ForceUnlockReply
    boolean

    Returns true if unlocking sequence was successfully executed

  • ForceUnlockRequest
    integer

    Specifies the ID of the connector that should be unlocked

  • PauseChargingReply
    boolean

    Reply to pause charging request. 'true' on success

  • RandomDelayDuration
    integer

    Maximum duration in seconds

  • Ready
    boolean

    'true' signals ready

  • ResumeChargingReply
    boolean

    Reply to resume charging request. 'true' on success, false otherwise (e.g. resuming a car pause won't work)

  • SelectedProtocol
    string

    The selected protocol for charging

  • object

    Emits all events related to sessions

  • SessionEventEnum
    string

    Session Event enum

    • Authorized: Signaled when the EVSE is authorized for charging
    • Deauthorized: Signaled when the EVSE is not authorized for charging (anymore)
    • Enabled: Signaled when the EVSE is enabled (e.g. after an enable command)
    • Disabled: Signaled when the EVSE is disabled (e.g. after a disable command)
    • SessionStarted: Signaled when a session has been started. A session has been started either when an EV is plugged in or the user has been authorized to start a transaction (e.g. after an authorize command)
    • AuthRequired: Signaled when an EVSE needs authorization to start a transaction
    • TransactionStarted: Signaled when a transaction has been started. Transaction starts at the point that all conditions for charging are met: EV is connected and user has been authorized
    • PrepareCharging: EVSE started to prepare for charging. DC: CableCheck, PreCharge, PowerDelivery. AC: wait for the car to proceed to state C/D
    • ChargingStarted: DC: CurrentDemand has started. AC: Auth is ok and car requested power (state C/D)
    • ChargingPausedEV: Signaled when charging is paused by the EV
    • WaitingForEnergy: Waiting for ernergy manager
    • ChargingPausedEVSE: Signaled when charging is paused by the EVSE
    • ChargingResumed: Charging has resumed from a pause
    • StoppingCharging: EVSE has started to stop the charging process. DC: CurrentDemand has finished, now doing WeldingCheck etc, AC: Wait for car to return to state B or A
    • ChargingFinished: Charging is finished. Essentially the same as TransactionFinished, but emitted for clarity
    • TransactionFinished: Signaled when the transaction finished. Transaction finishes at the point where one of the preconditions for charging irrevocably becomes false: When a user swipes to stop the transaction and the stop is authorized.
    • SessionFinished: Session finishes at the point that the EVSE is available again (no cable plugged)
    • ReservationStart: Signaled when a reservation starts
    • ReservationEnd: Signaled when a reservation ends
    • ReplugStarted: Signaled when the EVSE Manager virtually replugs without interrupting the session or transaction
    • ReplugFinished: Signaled when the virtual replug process has finished
    • PluginTimeout: Signaled when an EV has been Plugged in but no authorization is present within specified ConnectionTimeout
    • SwitchingPhases: Signals that 1ph/3ph switching was started on AC charging
    • SessionResumed: Signaled when a session is resumed at startup (e.g. because of previous powerloss)
      Allowed values:
    • "Authorized"
    • "Deauthorized"
    • "Enabled"
    • "Disabled"
    • "SessionStarted"
    • "AuthRequired"
    • "TransactionStarted"
    • "PrepareCharging"
    • "ChargingStarted"
    • "ChargingPausedEV"
    • "ChargingPausedEVSE"
    • "WaitingForEnergy"
    • "ChargingResumed"
    • "StoppingCharging"
    • "ChargingFinished"
    • "TransactionFinished"
    • "SessionFinished"
    • "ReservationStart"
    • "ReservationEnd"
    • "ReplugStarted"
    • "ReplugFinished"
    • "PluginTimeout"
    • "SwitchingPhases"
    • "SessionResumed"
  • object

    Data for the SessionFinished event

  • object

    Data for the SessionStarted event

  • SlacDlinkReady
    boolean

    Inform higher layers about a change in data link status. Emits true if link was set up and false when the link is shut down.

  • StartSessionReason
    string

    Reason for session start

    • EVConnected: Session was started because an EV was plugged in
    • Authorized: Session was started because a valid authorization was presented and the EVSE is authorized to start a transaction immediately when an EV is plugged in
      Allowed values:
    • "EVConnected"
    • "Authorized"
  • StopTransactionReason
    string

    Reason for stopping transaction

    • EmergencyStop: Emergency stop button was used
    • EVDisconnected: Disconnecting of cable, vehicle moved away from inductive charge unit
    • HardReset: A hard reset command was received previously
    • Local: Stopped locally on request of the user at the Charge Point. This is a regular termination of a transaction. Examples: presenting an RFID tag, pressing a button to stop
    • Other: Any other reason
    • PowerLoss: Complete loss of power
    • Reboot: A locally initiated reset/reboot occurred
    • Remote: Stopped remotely on request of the user. This is a regular termination of a transaction. Examples: termination using a smartphone app, exceeding a (non local) prepaid credit
    • SoftReset: A soft reset command was received
    • UnlockCommand: Central System sent an Unlock Connector command
    • DeAuthorized: The transaction was stopped because of the authorization status in a StartTransaction.conf
    • EnergyLimitReached: Maximum energy of charging reached. For example: in a pre-paid charging solution
    • GroundFault: A GroundFault has occurred
    • LocalOutOfCredit: A local credit limit enforced through the Charging Station has been exceeded.
    • MasterPass: The transaction was stopped using a token with a MasterPassGroupId.
    • OvercurrentFault: A larger than intended electric current has occurred
    • PowerQuality: Quality of power too low, e.g. voltage too low/high, phase imbalance, etc.
    • SOCLimitReached: Electric vehicle has reported reaching a locally enforced maximum battery State of Charge (SOC)
    • StoppedByEV: The transaction was stopped by the EV
    • TimeLimitReached: EV charging session reached a locally enforced time limit
    • Timeout: EV not connected within timeout
    • ReqEnergyTransferRejected: OCPP CSMS cannot accept the requested energy transfer type.
      Allowed values:
    • "EmergencyStop"
    • "EVDisconnected"
    • "HardReset"
    • "Local"
    • "Other"
    • "PowerLoss"
    • "Reboot"
    • "Remote"
    • "SoftReset"
    • "UnlockCommand"
    • "DeAuthorized"
    • "EnergyLimitReached"
    • "GroundFault"
    • "LocalOutOfCredit"
    • "MasterPass"
    • "OvercurrentFault"
    • "PowerQuality"
    • "SOCLimitReached"
    • "StoppedByEV"
    • "TimeLimitReached"
    • "Timeout"
    • "ReqEnergyTransferRejected"
  • object

    Request for a stop transaction containing the reason and an optional id tag

  • StopTransactionReply
    boolean

    Reply to stop transaction request. 'true' on success

  • object

    Data for the TransactionStarted event

  • object

    Data for TransactionFinished event

  • CommunicationCheck
    boolean

    Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

  • HeartBeatId
    integer

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