EVerest API definition for isolation monitors 1.0.0

API for EVerest API clients implementing isolation monitoring.

  • #EVerest
  • #isolation monitor

Servers

  • mqtt://localhost:1883/everest_api/1/isolation_monitor/{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/receive_start

    Direction: EVerest to Module

    By receiving the start command the monitoring of the isolation status should be started. Measurement data should be sent in user dependent interval until the stop command is received.

    Operation IDreceive_start

    Available only on servers:

    Accepts the following message:

    Receive start commandreceive_start

    Start recurring isolation measurements. The device should monitor the isolation status until stopped and publish the resistance data in regular intervals. The actual interval is device dependent.

    Message IDreceive_start
    Payload
    any

    Examples

  • RECEIVE e2m/receive_stop

    Direction: EVerest to Module

    By receiving the stop command the monitoring of the isolation status should be stoped. Measurement data must not be sent until the next start command is received.

    Operation IDreceive_stop

    Available only on servers:

    Accepts the following message:

    Receive stop commandreceive_stop

    Stop recurring measurements. The device should stop to monitor the isolation resistance and stop publishing the data.

    Message IDreceive_stop
    Payload
    any

    Examples

  • RECEIVE e2m/receive_start_self_test

    Direction: EVerest to Module

    The EvseManager will enable a DC voltage to support the testing, but will not enable output relais such that there is no high voltage on the external plug. The "self_test_result" variable must be published once the self testing is done.

    Operation IDreceive_start_self_test

    Available only on servers:

    Accepts the following message:

    Receive start self test commandreceive_start_self_test

    Start self test. EvseManager will enable a DC voltage to support the testing, but will not enable output relais such that there is no high voltage on the external plug.

    Message IDreceive_start_self_test
    Payload
    number

    Voltage for the isolation monitor self test

    Examples

  • SEND m2e/isolation_measurement

    Direction: Module to EVerest

    This operation is used to send a dataset of measured values. The isolation resistance (in Ohm) is required. The voltage is optional.

    Operation IDsend_isolation_measurement

    Available only on servers:

    Accepts the following message:

    Send isolation monitor measurementsend_isolation_measurement

    Isolation monitoring measurement results

    Message IDsend_isolation_measurement
    object

    Results of an isolation measurement

    Examples

  • SEND m2e/self_test_result

    Direction: Module to EVerest

    This operation is used to send the result of the self test.

    Operation IDsend_self_test_result

    Available only on servers:

    Accepts the following message:

    Send self test resultsend_self_test_result

    Self test result

    Message IDsend_self_test_result
    Payload
    boolean

    Indicates the self test is done and publishes the result. Set "true" for success, "false" for failure.

    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 Isolation Monitor Note that actual isolation faults should just be reported as resistance values, EvseManager will interpret them according to the limits given in the norm and stop charging. This is only to report device errors to indicate valid isolation resistance measurements etc are no longer possible.

    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 Isolation Monitor Note that actual isolation faults should just be reported as resistance values, EvseManager will interpret them according to the limits given in the norm and stop charging. This is only to report device errors to indicate valid isolation resistance measurements etc are no longer possible.

    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

  • #1Receive start commandreceive_start

    Start recurring isolation measurements. The device should monitor the isolation status until stopped and publish the resistance data in regular intervals. The actual interval is device dependent.

    Message IDreceive_start
    Payload
    any
  • #2Receive stop commandreceive_stop

    Stop recurring measurements. The device should stop to monitor the isolation resistance and stop publishing the data.

    Message IDreceive_stop
    Payload
    any
  • #3Receive start self test commandreceive_start_self_test

    Start self test. EvseManager will enable a DC voltage to support the testing, but will not enable output relais such that there is no high voltage on the external plug.

    Message IDreceive_start_self_test
    Payload
    number

    Voltage for the isolation monitor self test

  • #4Send isolation monitor measurementsend_isolation_measurement

    Isolation monitoring measurement results

    Message IDsend_isolation_measurement
    object

    Results of an isolation measurement

  • #5Send self test resultsend_self_test_result

    Self test result

    Message IDsend_self_test_result
    Payload
    boolean

    Indicates the self test is done and publishes the result. Set "true" for success, "false" for failure.

  • #6Send raise errorsend_raise_error

    Signal to EVerest that an error happened.

    Message IDsend_raise_error
    object

    Errors for Isolation Monitor Note that actual isolation faults should just be reported as resistance values, EvseManager will interpret them according to the limits given in the norm and stop charging. This is only to report device errors to indicate valid isolation resistance measurements etc are no longer possible.

  • #7Send clear errorsend_clear_error

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

    Message IDsend_clear_error
    object

    Errors for Isolation Monitor Note that actual isolation faults should just be reported as resistance values, EvseManager will interpret them according to the limits given in the norm and stop charging. This is only to report device errors to indicate valid isolation resistance measurements etc are no longer possible.

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

  • #9Send 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

    Results of an isolation measurement

  • SelfTestResult
    boolean

    Indicates the self test is done and publishes the result. Set "true" for success, "false" for failure.

  • SelfTestVoltage
    number

    Voltage for the isolation monitor self test

  • ErrorEnum
    string

    Type of error

    • DeviceFault: The IMD device is not fully functional anymore and cannot be used to monitor the isolation resistance.
    • CommunicationFault: The communication to the hardware or underlying driver is lost or has errors.
    • VendorError: Vendor specific error code. Will stop charging session.
    • VendorWarning: Vendor specific error code. Charging may continue.
      Allowed values:
    • "DeviceFault"
    • "CommunicationFault"
    • "VendorError"
    • "VendorWarning"
  • object

    Errors for Isolation Monitor Note that actual isolation faults should just be reported as resistance values, EvseManager will interpret them according to the limits given in the norm and stop charging. This is only to report device errors to indicate valid isolation resistance measurements etc are no longer possible.

  • 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