API for EVerest API clients that consume session cost and tariff information from the session_cost interface. See the Integrate Tariff and Cost how-to guide for OCPP-specific configuration and message flow details.
default local MQTT
The ID of the module as defined in the EVerest config file.
Published once on startup and again whenever the applicable default price changes (e.g. after a connectivity state change or a configuration update). Contains human-readable price text in one or more languages. Absent if no default price is configured.
Available only on servers:
Accepts the following message:
Currently applicable default pricing text for this charger
The currently applicable default pricing text for this charger, independent of any active session. Contains human-readable text only — no computed cost amounts are included. Published once on startup and again whenever the applicable price changes (e.g. after a connectivity state change or a configuration update).
{
"messages": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
]
}
Published at authorization time and whenever the CSMS sends updated pricing during a session. Contains human-readable price text in one or more languages.
Available only on servers:
Accepts the following message:
Tariff and pricing information for a charging session
Message containing cost information
{
"ocpp_transaction_id": "string",
"identifier_id": "string",
"identifier_type": "IdToken",
"messages": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
]
}
Published periodically during a session and once when it ends. Contains session cost broken down into chunks, current and upcoming pricing, and optional display messages.
Available only on servers:
Accepts the following message:
Running or final cost of a charging session
Session cost object containing the total cost of the session and a list of chunks
{
"id_tag": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"session_id": "string",
"currency": {
"code": "AED",
"decimals": 0
},
"cost_chunks": [
{
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"metervalue_from": 0,
"metervalue_to": 0,
"cost": {
"value": 0
},
"category": "Energy"
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
},
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"next_period": {
"timestamp_from": "2019-08-24T14:15:22Z",
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
},
"status": "Running",
"message": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
],
"qr_code": "string"
}
Request the most recently published (latched) Default Price. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.
Available only on servers:
Accepts the following message:
Request the most recently published (latched) Default Price.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Accepts the following message:
The most recently published Default Price.
{
"messages": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
]
}
Request the most recently published (latched) Tariff Message. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.
Available only on servers:
Accepts the following message:
Request the most recently published (latched) Tariff Message.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Accepts the following message:
The most recently published Tariff Message.
{
"ocpp_transaction_id": "string",
"identifier_id": "string",
"identifier_type": "IdToken",
"messages": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
]
}
Request the most recently published (latched) Session Cost. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.
Available only on servers:
Accepts the following message:
Request the most recently published (latched) Session Cost.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Accepts the following message:
The most recently published Session Cost.
{
"id_tag": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"session_id": "string",
"currency": {
"code": "AED",
"decimals": 0
},
"cost_chunks": [
{
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"metervalue_from": 0,
"metervalue_to": 0,
"cost": {
"value": 0
},
"category": "Energy"
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
},
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"next_period": {
"timestamp_from": "2019-08-24T14:15:22Z",
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
},
"status": "Running",
"message": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
],
"qr_code": "string"
}
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 module is alive. Send 'false' to stop communication check'
CommunicationCheck
Currently applicable default pricing text for this charger
The currently applicable default pricing text for this charger, independent of any active session. Contains human-readable text only — no computed cost amounts are included. Published once on startup and again whenever the applicable price changes (e.g. after a connectivity state change or a configuration update).
Tariff and pricing information for a charging session
Message containing cost information
Running or final cost of a charging session
Session cost object containing the total cost of the session and a list of chunks
Request the most recently published (latched) Default Price.
The most recently published Default Price.
Request the most recently published (latched) Tariff Message.
The most recently published Tariff Message.
Request the most recently published (latched) Session Cost.
The most recently published Session Cost.
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 module is alive. Send 'false' to stop communication check'
The currently applicable default pricing text for this charger, independent of any active session. Contains human-readable text only — no computed cost amounts are included. Published once on startup and again whenever the applicable price changes (e.g. after a connectivity state change or a configuration update).
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached