API for EVerest API clients for raising and clearing generic errors.
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:
Signal to EVerest that an error happened.
Error object with type, subtype and message.
Raise error example
{
"type": "CommunicationFault",
"sub_type": "subtype",
"message": "message"
}
Accepts the following message:
Signal to EVerest that a previously raised error is no longer active.
Error object with type, subtype and message.
Raise error example
{
"type": "CommunicationFault",
"sub_type": "subtype",
"message": "message"
}
Direction: EVerest to Module
Available only on servers:
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
Signal to EVerest that an error happened.
Error object with type, subtype and message.
Signal to EVerest that a previously raised error is no longer active.
Error object with type, subtype and 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
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'
Type of error
Error object with type, subtype and message.
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