API for EVerest API clients for error status and history.
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:
Request the list of filtered errors.
{
"headers": {
"replyTo": "string"
},
"payload": {
"state_filter": "Active",
"origin_filter": {
"module_id": "string",
"implementation_id": "string"
},
"type_filter": "string",
"severity_filter": "HIGH_GE",
"timeperiod_filter": {
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z"
},
"handle_filter": "string"
}
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to the request to send the list of filtered errors
A list of ErrorObjects
{
"errors": [
{
"type": "string",
"sub_type": "string",
"description": "string",
"message": "string",
"severity": "High",
"origin": {
"module_id": "string",
"implementation_id": "string"
},
"timestamp": "2019-08-24T14:15:22Z",
"uuid": "string",
"state": "Active"
}
]
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Request the list of active errors.
Request active errors
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to the request to send the list of active errors
A list of ErrorObjects
{
"errors": [
{
"type": "string",
"sub_type": "string",
"description": "string",
"message": "string",
"severity": "High",
"origin": {
"module_id": "string",
"implementation_id": "string"
},
"timestamp": "2019-08-24T14:15:22Z",
"uuid": "string",
"state": "Active"
}
]
}
Accepts the following message:
Notifies on every raised error
Represents an error
{
"type": "string",
"sub_type": "string",
"description": "string",
"message": "string",
"severity": "High",
"origin": {
"module_id": "string",
"implementation_id": "string"
},
"timestamp": "2019-08-24T14:15:22Z",
"uuid": "string",
"state": "Active"
}
Request the most recently published (latched) error raised. 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) raised errors.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Accepts the following message:
The most recently published raised errors.
{
"type": "string",
"sub_type": "string",
"description": "string",
"message": "string",
"severity": "High",
"origin": {
"module_id": "string",
"implementation_id": "string"
},
"timestamp": "2019-08-24T14:15:22Z",
"uuid": "string",
"state": "Active"
}
Accepts the following message:
Notifies when an error is cleared
Represents an error
{
"type": "string",
"sub_type": "string",
"description": "string",
"message": "string",
"severity": "High",
"origin": {
"module_id": "string",
"implementation_id": "string"
},
"timestamp": "2019-08-24T14:15:22Z",
"uuid": "string",
"state": "Active"
}
Request the most recently published (latched) error cleared. 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) cleared errors.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Accepts the following message:
The most recently published cleared errors.
{
"type": "string",
"sub_type": "string",
"description": "string",
"message": "string",
"severity": "High",
"origin": {
"module_id": "string",
"implementation_id": "string"
},
"timestamp": "2019-08-24T14:15:22Z",
"uuid": "string",
"state": "Active"
}
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
Request the list of filtered errors.
Reply to the request to send the list of filtered errors
A list of ErrorObjects
Request the list of active errors.
Reply to the request to send the list of active errors
A list of ErrorObjects
Notifies on every raised error
Represents an error
Request the most recently published (latched) raised errors.
The most recently published raised errors.
Notifies when an error is cleared
Represents an error
Request the most recently published (latched) cleared errors.
The most recently published cleared errors.
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.
A list of ErrorObjects
Represents an error
Arguments for the get_errors command
Identifier of an implementation
Severity of an error. Deprecated: will be removed in 2027.04.0.
Severity filter for errors. Deprecated: will be removed in 2027.04.0.
State of an error
Timeperiod filter for errors
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