EVerest API definition for external energy limits 1.0.0

API to allow EVerest API clients to set energy limits.

  • #EVerest
  • #external energy limits

Servers

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

  • SEND m2e/set_external_limits

    Operation IDsend_set_external_limits

    Available only on servers:

    Accepts the following message:

    Send external energy limitssend_set_external_limits

    External energy limits

    Message IDsend_set_external_limits
    object

    External Limits data type

    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

  • #1Send external energy limitssend_set_external_limits

    External energy limits

    Message IDsend_set_external_limits
    object

    External Limits data type

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

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

    External Limits data type

  • object

    A point of a frequency-watt curve

  • object

    Simple number type with source information

  • object

    Energy flow limiting object request (Evses to EnergyManager)

  • object

    Energy flow limiting object Result (Energy manager to Evses)

  • object

    Simple number type with source information

  • object

    Price information for this timepoint

  • object

    One entry for the time series (request)

  • object

    One entry for the time series (result)

  • object

    One entry for the time series (setpoint request)

  • object

    Defines a setpoint

  • 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