API for EVerest API client implementing the system capabilities OTA update and log upload.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request to update the firmware.
{
"headers": {
"replyTo": "string"
},
"payload": {
"retries": 1,
"retry_interval_s": 0,
"request_id": 0,
"location": "string",
"retrieve_timestamp": "2019-08-24T14:15:22Z",
"install_timestamp": "2019-08-24T14:15:22Z",
"signing_certificate": "string",
"signature": "string"
}
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to update firmware request.
Enum for the response of an update_firmware command Accepted: Accepted this firmware update request. This does not mean the firmware update is successful, the system will now start the firmware update process Rejected: Firmware update request rejected AcceptedCanceled: Accepted this firmware update request, but in doing this has cancelled an ongoing firmware update InvalidCertificate: The certificate is invalid RevokedCertificate: Failure end state. The Firmware Signing certificate has been revoked
Update firmware
Accepted
Available only on servers:
Accepts the following message:
Call to allow firmware installation to proceed
Call to allow a firmware installation to proceed. This is usually called after a firmware update has been downloaded. OCPP requires to move all EVSE to an unavailable state prior to installing new firmware. EVerest will take care of this and call this function when all EVSE are in unavailable state to signal that installation can proceed.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request to upload logs.
{
"headers": {
"replyTo": "string"
},
"payload": {
"retries": 1,
"retry_interval_s": 0,
"oldest_timestamp": "2019-08-24T14:15:22Z",
"latest_timestamp": "2019-08-24T14:15:22Z",
"location": "string",
"type": "string",
"request_id": 0
}
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to upload logs request.
Response to a upload logs request
Upload logs
{
"file_name": "string",
"upload_logs_status": "Accepted"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request if is reset allowed. This is usually called prior to a reset request.
{
"headers": {
"replyTo": "string"
},
"payload": "Soft"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to is reset allowed request.
true if reset is allowed
CommunicationCheck
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Call to reset the system immediately
request for reset
{
"type": "Soft",
"scheduled": true
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Call to set the system time
{
"headers": {
"replyTo": "string"
},
"payload": "2019-08-24T14:15:22Z"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to is reset allowed request.
true if reset successful
CommunicationCheck
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Call to get the boot reason
{
"headers": {
"replyTo": "string"
}
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to get boot reason.
Enum defining the boot reason
Get boot reason
ApplicationReset
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Describes the current status of a firmware update of the system
Type defining the status of a firmware update
Firmware update status
{
"firmware_update_status": "Downloaded",
"request_id": 0
}
Accepts the following message:
Describes the current status of log upload of the system
Type defining the status of a log upload
Log upload status
{
"log_status": "BadMessage",
"request_id": 0
}
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
Request to update the firmware.
Reply to update firmware request.
Enum for the response of an update_firmware command Accepted: Accepted this firmware update request. This does not mean the firmware update is successful, the system will now start the firmware update process Rejected: Firmware update request rejected AcceptedCanceled: Accepted this firmware update request, but in doing this has cancelled an ongoing firmware update InvalidCertificate: The certificate is invalid RevokedCertificate: Failure end state. The Firmware Signing certificate has been revoked
Request to upload logs.
Reply to upload logs request.
Response to a upload logs request
Request if is reset allowed. This is usually called prior to a reset request.
Reply to is reset allowed request.
true if reset is allowed
Call to set the system time
Reply to is reset allowed request.
true if reset successful
Call to get the boot reason
Reply to get boot reason.
Enum defining the boot reason
Call to allow firmware installation to proceed
Call to allow a firmware installation to proceed. This is usually called after a firmware update has been downloaded. OCPP requires to move all EVSE to an unavailable state prior to installing new firmware. EVerest will take care of this and call this function when all EVSE are in unavailable state to signal that installation can proceed.
Call to reset the system immediately
request for reset
Describes the current status of a firmware update of the system
Type defining the status of a firmware update
Describes the current status of log upload of the system
Type defining the status of a log upload
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'
Enum defining the boot reason
Type defining a Firmware update request
Type defining the status of a firmware update
State describing the current download/upload status of a firmware update of the system Downloaded: Intermediate state. New firmware has been downloaded by System DownloadFailed: Failure end state. System failed to download firmware Downloading: Intermediate state. Firmware is being downloaded DownloadScheduled: Intermediate state. Downloading of new firmware has been scheduled DownloadPaused: Intermediate state. Downloading has been paused Idle: System is not performing firmware update related tasks InstallationFailed: Failure end state. Installation of new firmware has failed Installing: Intermediate state. Firmware is being installed Installed: Successful end state. New firmware has successfully been installed in System InstallRebooting: Intermediate state. System is about to reboot to activate new firmware InstallScheduled: Intermediate state. Installation of the downloaded firmware is scheduled to take place on installDateTime InstallVerificationFailed: Failure end state. Verification of the new firmware (e.g. using a checksum or some other means) has failed and installation will not proceed. (Final failure state) InvalidSignature: Failure end state. The firmware signature is not valid SignatureVerified: Intermediate state. Provide signature successfully verified
State describing the current status of log upload of the system BadMessage: A badly formatted packet or other protocol incompatibility was detected Idle: The system is not uploading a log file NotSupportedOperation: The server does not support the operation PermissionDenied: Insufficient permissions to perform the operation Uploaded: File has been uploaded successfully UploadFailure: Failed to upload the requested file Uploading: File is being uploaded
Type defining the status of a log upload
true if reset is allowed
request for reset
Enum defining the type of a reset
system time in RFC3339 format
true if reset successful
Enum for the response of an update_firmware command Accepted: Accepted this firmware update request. This does not mean the firmware update is successful, the system will now start the firmware update process Rejected: Firmware update request rejected AcceptedCanceled: Accepted this firmware update request, but in doing this has cancelled an ongoing firmware update InvalidCertificate: The certificate is invalid RevokedCertificate: Failure end state. The Firmware Signing certificate has been revoked
Type defining an upload logs request.
Response to a upload logs request
Enum for the upload logs status response Accepted: Request to upload logs has been accepted Rejected: Request to upload logs has been rejected AcceptedCanceled: Accepted this log upload, but in doing this has cancelled an ongoing log file upload
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