EVerest API definition for the charger information module 1.0.0 documentation

EVerest API definition for the charger information module 1.0.0

Apache-2.0
application/json
ID: pionix:de:everest:charger_information_API

API for EVerest API clients providing the charger information (vendor, model, serial numbers, firmware version, ...) to EVerest. EVerest requests the information on demand; the client answers each request with a ChargerInformation object. Modules such as OCPP and the API modules request the charger information once during their startup and block until the reply arrives. If no reply arrives within cfg_request_reply_to_s seconds, EVerest continues with empty vendor and model strings, so the client should be connected and answering before EVerest starts.

#EVerest
#ChargerInformationAPI

Servers

mqtt://localhost:1883/everest_api/1/charger_information/{module_id}mqttdefault
default local MQTT

object
module_id
required
string
The ID of the module as defined in the EVerest config file.

Operations

REPLY e2m/get_charger_information
Direction: EVerest to Module. The client must reply on the replyTo address: EVerest blocks the requesting module until a reply arrives or the request times out.

Operation IDreceive_request_get_charger_information
Available only on servers:
- default
Accepts the following message:
Receive get charger information requestreceive_request_get_charger_information
Call to get the charger information
application/json
Message IDreceive_request_get_charger_information
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
Request charger information
{ "headers": { "replyTo": "reply/to/address" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Dynamically defined channel. Used to reply to a get_charger_information request.

Available only on servers:
default
Message:
Reply to get charger informationsend_reply_get_charger_information
Reply to get charger information.
application/json
Message IDsend_reply_get_charger_information
object
Type holding (mostly static) meta information about the whole charger. Vendor and manufacturer refer to the very same company - it is the brand which appears physically on the device label and/or which is shown on the device's web frontend, in UPnP etc. Both terms are used to differentiate the different usages - with legal suffix, or without.

vendor
required
string
Name of vendor, not including any legal form. Is typically used with model to form a unique product name aka vendor + single whitespace + model. Example: Pionix

model
required
string
A human-friendly name of the model, aka the product name; without vendor name, without any device specific data/numbers (serial numbers/MAC addresses). Example: BelayBox

chargepoint_serial
string
The traditional serial number as string. It does not necessarily consist of digits only. Usually, this serial appears also on a label on the device. Example: SH4CAWN00123

chargebox_serial
string
The serial number of the controller as string (if any). It does not necessarily consist of digits only. Example: CB123456

friendly_name
string
A string which can be used to display the device e.g. in network listings/enumerations. This could typically consist of vendor + single whitespace + model + [ + serial + ].

manufacturer
string
The name of the vendor, but this may include the legal form. Typically used in product property lists or as text for the following URL.

manufacturer_url
string
An URL to the vendor website, ideally not a deep link so that it is available for the whole product lifetime.

model_url
string
An URL to the model website (if any); as above, ideally not a deep link.

model_number
string
A model number as string (if any).

model_revision
string
A model or product revision string. Very often this is not defined for the first one so that users of this variable should consider reasonable fallback/default values.

board_revision
string
The revision (aka version) of the internal (main) PCB, i.e. the one with the CPU running the EVerest system.

firmware_version
string
A string containing the current running firmware version of the complete system. This is typically not the EVerest version itself, but a firmware version which appears e.g. on the web frontend and as part of the filenames the customer can download from the manufacturer's website.

Additional properties are NOT allowed.
Examples
#1 Example
Charger information
{ "vendor": "Pionix", "model": "BelayBox", "chargepoint_serial": "SH4CAWN00123", "chargebox_serial": "CB123456", "friendly_name": "Pionix BelayBox [SH4CAWN00123]", "manufacturer": "Pionix GmbH", "manufacturer_url": "https://pionix.com", "model_revision": "B", "board_revision": "1.2", "firmware_version": "2026.10.0" }

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
SEND
Dynamically defined channel. Used to reply to a get_charger_information request.

Direction: Module to EVerest

Operation IDsend_reply_get_charger_information
Available only on servers:
- default
Accepts the following message:
Reply to get charger informationsend_reply_get_charger_information
Reply to get charger information.
application/json
Message IDsend_reply_get_charger_information
object
Type holding (mostly static) meta information about the whole charger. Vendor and manufacturer refer to the very same company - it is the brand which appears physically on the device label and/or which is shown on the device's web frontend, in UPnP etc. Both terms are used to differentiate the different usages - with legal suffix, or without.

vendor
required
string
Name of vendor, not including any legal form. Is typically used with model to form a unique product name aka vendor + single whitespace + model. Example: Pionix

model
required
string
A human-friendly name of the model, aka the product name; without vendor name, without any device specific data/numbers (serial numbers/MAC addresses). Example: BelayBox

chargepoint_serial
string
The traditional serial number as string. It does not necessarily consist of digits only. Usually, this serial appears also on a label on the device. Example: SH4CAWN00123

chargebox_serial
string
The serial number of the controller as string (if any). It does not necessarily consist of digits only. Example: CB123456

friendly_name
string
A string which can be used to display the device e.g. in network listings/enumerations. This could typically consist of vendor + single whitespace + model + [ + serial + ].

manufacturer
string
The name of the vendor, but this may include the legal form. Typically used in product property lists or as text for the following URL.

manufacturer_url
string
An URL to the vendor website, ideally not a deep link so that it is available for the whole product lifetime.

model_url
string
An URL to the model website (if any); as above, ideally not a deep link.

model_number
string
A model number as string (if any).

model_revision
string
A model or product revision string. Very often this is not defined for the first one so that users of this variable should consider reasonable fallback/default values.

board_revision
string
The revision (aka version) of the internal (main) PCB, i.e. the one with the CPU running the EVerest system.

firmware_version
string
A string containing the current running firmware version of the complete system. This is typically not the EVerest version itself, but a firmware version which appears e.g. on the web frontend and as part of the filenames the customer can download from the manufacturer's website.

Additional properties are NOT allowed.
Examples
#1 Example
Charger information
{ "vendor": "Pionix", "model": "BelayBox", "chargepoint_serial": "SH4CAWN00123", "chargebox_serial": "CB123456", "friendly_name": "Pionix BelayBox [SH4CAWN00123]", "manufacturer": "Pionix GmbH", "manufacturer_url": "https://pionix.com", "model_revision": "B", "board_revision": "1.2", "firmware_version": "2026.10.0" }
RECEIVE e2m/heartbeat
Direction: EVerest to Module

Operation IDreceive_heartbeat
Available only on servers:
- default
Accepts the following message:
Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
application/json
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
#1 Example
Heartbeat
42
SEND m2e/communication_check
Direction: Module to EVerest

Operation IDsend_communication_check
Available only on servers:
- default
Accepts the following message:
Send communication checksend_communication_check
Send communication check to EVerest to signal the module is alive
application/json
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
#1 Example
Communication check

Messages

#1Receive get charger information requestreceive_request_get_charger_information
Call to get the charger information
- application/json
Message IDreceive_request_get_charger_information
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#2Reply to get charger informationsend_reply_get_charger_information
Reply to get charger information.
- application/json
Message IDsend_reply_get_charger_information
object
Type holding (mostly static) meta information about the whole charger. Vendor and manufacturer refer to the very same company - it is the brand which appears physically on the device label and/or which is shown on the device's web frontend, in UPnP etc. Both terms are used to differentiate the different usages - with legal suffix, or without.

vendor
required
string
Name of vendor, not including any legal form. Is typically used with model to form a unique product name aka vendor + single whitespace + model. Example: Pionix

model
required
string
A human-friendly name of the model, aka the product name; without vendor name, without any device specific data/numbers (serial numbers/MAC addresses). Example: BelayBox

chargepoint_serial
string
The traditional serial number as string. It does not necessarily consist of digits only. Usually, this serial appears also on a label on the device. Example: SH4CAWN00123

chargebox_serial
string
The serial number of the controller as string (if any). It does not necessarily consist of digits only. Example: CB123456

friendly_name
string
A string which can be used to display the device e.g. in network listings/enumerations. This could typically consist of vendor + single whitespace + model + [ + serial + ].

manufacturer
string
The name of the vendor, but this may include the legal form. Typically used in product property lists or as text for the following URL.

manufacturer_url
string
An URL to the vendor website, ideally not a deep link so that it is available for the whole product lifetime.

model_url
string
An URL to the model website (if any); as above, ideally not a deep link.

model_number
string
A model number as string (if any).

model_revision
string
A model or product revision string. Very often this is not defined for the first one so that users of this variable should consider reasonable fallback/default values.

board_revision
string
The revision (aka version) of the internal (main) PCB, i.e. the one with the CPU running the EVerest system.

firmware_version
string
A string containing the current running firmware version of the complete system. This is typically not the EVerest version itself, but a firmware version which appears e.g. on the web frontend and as part of the filenames the customer can download from the manufacturer's website.

Additional properties are NOT allowed.
#3Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
- application/json
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
Send communication check to EVerest to signal the module is alive
- application/json
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
Type holding (mostly static) meta information about the whole charger. Vendor and manufacturer refer to the very same company - it is the brand which appears physically on the device label and/or which is shown on the device's web frontend, in UPnP etc. Both terms are used to differentiate the different usages - with legal suffix, or without.

vendor
required
string
Name of vendor, not including any legal form. Is typically used with model to form a unique product name aka vendor + single whitespace + model. Example: Pionix

model
required
string
A human-friendly name of the model, aka the product name; without vendor name, without any device specific data/numbers (serial numbers/MAC addresses). Example: BelayBox

chargepoint_serial
string
The traditional serial number as string. It does not necessarily consist of digits only. Usually, this serial appears also on a label on the device. Example: SH4CAWN00123

chargebox_serial
string
The serial number of the controller as string (if any). It does not necessarily consist of digits only. Example: CB123456

friendly_name
string
A string which can be used to display the device e.g. in network listings/enumerations. This could typically consist of vendor + single whitespace + model + [ + serial + ].

manufacturer
string
The name of the vendor, but this may include the legal form. Typically used in product property lists or as text for the following URL.

manufacturer_url
string
An URL to the vendor website, ideally not a deep link so that it is available for the whole product lifetime.

model_url
string
An URL to the model website (if any); as above, ideally not a deep link.

model_number
string
A model number as string (if any).

model_revision
string
A model or product revision string. Very often this is not defined for the first one so that users of this variable should consider reasonable fallback/default values.

board_revision
string
The revision (aka version) of the internal (main) PCB, i.e. the one with the CPU running the EVerest system.

firmware_version
string
A string containing the current running firmware version of the complete system. This is typically not the EVerest version itself, but a firmware version which appears e.g. on the web frontend and as part of the filenames the customer can download from the manufacturer's website.

Additional properties are NOT allowed.
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

EVerest API definition for the charger information module 1.0.0

Servers

Operations

REPLY e2m/get_charger_information

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

#1 Example

REPLY address information

SEND

Examples

#1 Example

RECEIVE e2m/heartbeat

Examples

#1 Example

SEND m2e/communication_check

Examples

#1 Example

Messages

Schemas