API for EVerest API clients implementing auth token provider.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
The provided token
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
The Provided Token
{
"authorization_type": "OCPP",
"id_token": {
"type": "Central",
"value": "TOKEN"
}
}
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
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.
CommunicationCheck
The provided token
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
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.
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.
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached