10.13. systemΒΆ

EVerest system types

FirmwareUpdateRequest:object
Type defining a Firmware update request
required: location, request_id
properties:
retries:integer
This specifies how many times the system must try to download the firmware before giving up.
retry_interval_s:integer
The interval in seconds after which a retry may be attempted
request_id:integer
The Id of this request
location:string
URI defining the origin of the firmware
retrieve_timestamp:string
Time when the firmware update shall be retrieved in RFC3339 format
format:
install_timestamp:string
Time when the firmware update shall be installed in RFC3339 format
format:
signing_certificate:string
Certificate with which the firmware was signed. PEM encoded X.509 certificate
signature:string
Base64 encoded firmware signature
UpdateFirmwareResponse:string
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
enum: Accepted, Rejected, AcceptedCancelled, InvalidCertificate, RevokedCertificate
UploadLogsRequest:object
Type defining an upload logs request.
required: location
properties:
retries:integer
This specifies how many the system must try to upload the logs before giving up.
retry_interval_s:integer
The interval in seconds after which an upload retry may be attempted
oldest_timestamp:string
Oldest timestamp that should be incluced in the log in RFC3339 format
format:
latest_timestamp:string
Latest timestamp that should be incluced in the log in RFC3339 format
format:
location:string
The URL of the location at the remote system where the log should be stored.
type:string
The type of the log (e.g. in OCPP there is the SecurityLog and the DiagnosticsLog
request_id:integer
The id of the request
UploadLogsStatus:string
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
enum: Accepted, Rejected, AcceptedCancelled
UploadLogsResponse:object
Response to a upload logs request
required: upload_logs_status
properties:
file_name:string
This contains the name of the log file that will be uploaded.
upload_logs_status:string (system-UploadLogsStatus)
The log status enum
There is an extended definition for this object here.
LogStatusEnum:string
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
enum: BadMessage, Idle, NotSupportedOperation, PermissionDenied, Uploaded, UploadFailure, Uploading
LogStatus:object
Type defining the status of a log upload
required: log_status, request_id
properties:
log_status:string (system-LogStatusEnum)
State describing the current status of log upload of the system
There is an extended definition for this object here.
request_id:integer
Id of the request
FirmwareUpdateStatusEnum:string
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
enum: Downloaded, DownloadFailed, Downloading, DownloadScheduled, DownloadPaused, Idle, InstallationFailed, Installing, Installed, InstallRebooting, InstallScheduled, InstallVerificationFailed, InvalidSignature, SignatureVerified
FirmwareUpdateStatus:object
Type defining the status of a firmware update
required: firmware_update_status, request_id
properties:
firmware_update_status:string (system-FirmwareUpdateStatusEnum)
State describing the current status of firmware update of the system
There is an extended definition for this object here.
request_id:integer
Id of the request
ResetType:string
Enum defining the type of a reset
enum: Soft, Hard