API for EVerest API clients implementing SLAC.
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:
Reset SLAC
true: start SLAC after reset, false: stop SLAC
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Signal pilot state change to B/C/D from A/E/F.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Signal pilot state change to A/E/F from B/C/D.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Terminate the data link and become UNMATCHED.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Terminate the data link and restart the matching process.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request power saving mode, while staying MATCHED.
Accepts the following message:
Example state MATCHED
{
"state": "MATCHED"
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Inform higher layers about a change in data link status. Emits true if link was set up and false when the link is shut down.
Example dlink_ready true
{
"dlink_ready": true
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Inform the higher layer to execute the error routine for a SLAC connection retry
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Inform higher layers about the MAC address of the vehicle (upper case)
Example MAC address
{
"ev_mac_address": "AA:BB:CC:DD:EE:FF"
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Signal to EVerest that an error happened.
Example error message
{
"type": "CommunicationFault",
"sub_type": "string",
"message": "string"
}
Accepts the following message:
Signal to EVerest that an error was resolved.
Signal to EVerest that a previously raised error is no longer active.
{
"type": "CommunicationFault",
"sub_type": "string",
"message": "string"
}
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'
Reset SLAC
true: start SLAC after reset, false: stop SLAC
Signal pilot state change to B/C/D from A/E/F.
Signal pilot state change to A/E/F from B/C/D.
Terminate the data link and become UNMATCHED.
Terminate the data link and restart the matching process.
Request power saving mode, while staying MATCHED.
Inform higher layers about a change in data link status. Emits true if link was set up and false when the link is shut down.
Inform the higher layer to execute the error routine for a SLAC connection retry
Inform higher layers about the MAC address of the vehicle (upper case)
Signal to EVerest that an error happened.
Signal to EVerest that an error was resolved.
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'
true: start SLAC after reset, false: stop SLAC
Type of Error
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