EVerest API definition for raising and clearing generic errors 1.1.0

API for EVerest API clients for raising and clearing generic errors. The errors are only reported, e.g. by OCPP and the error history. EvseManager does not act on them, so they do not stop charging.

  • #EVerest
  • #generic errors

Servers

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

    default local MQTT

    object
    module_id
    required
    string

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

Operations

  • 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

    Error object with type, subtype and message.

    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

    Error object with type, subtype and message.

    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

  • #1Send raise errorsend_raise_error

    Signal to EVerest that an error happened.

    Message IDsend_raise_error
    object

    Error object with type, subtype and message.

  • #2Send clear errorsend_clear_error

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

    Message IDsend_clear_error
    object

    Error object with type, subtype and message.

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

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

  • ErrorEnum
    string

    Type of error

    • CommunicationFault: The communication to the hardware or underlying driver is lost or has errors.
    • VendorError: Vendor specific error code.
    • VendorWarning: Vendor specific error code.
      Allowed values:
    • "CommunicationFault"
    • "VendorError"
    • "VendorWarning"
  • object

    Error object with type, subtype and message.

  • 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