API for EVerest API clients discovering the EVerest API capabilities.
default local MQTT
Allow API clients to discover the available capabilities of the API. Reply will not be monolithic but come in as many messages as there are modules.
Available only on servers:
Accepts the following message:
requesting available APIs
{
"headers": {
"replyTo": "your/arbitrary/reply/topic"
}
}
Accepts the following message:
Reply to request to discover the API.
Type for API discovery results
Reply from each module is an array of (id, type, <version>) tuples
{
"apis": [
{
"module_id": "module_1",
"type": "display_message",
"version": 1
},
{
"module_id": "module_1",
"type": "session_cost_consumer",
"version": 1
}
]
}
Allow API clients to discover specific types of APIs. Reply will not be monolithic but come in as many messages as there a matching modules.
Available only on servers:
The type of API to query
Accepts the following message:
requesting available APIs of type {api_type}
{
"headers": {
"replyTo": "your/arbitrary/reply/topic"
}
}
Accepts the following message:
Reply to request to query module.
Type for API discovery results
Reply from each module is an array of (id, type, <version>) tuples
{
"apis": [
{
"module_id": "dm_1",
"type": "display_message",
"version": 1
}
]
}
Accepts the following message:
A beacon to indicate the API is ready to be queried
a beacon to indicate the API is ready to be queried
Ready Beacon
{}
Reply to request to discover the API.
Type for API discovery results
Reply to request to query module.
Type for API discovery results
A beacon to indicate the API is ready to be queried
a beacon to indicate the API is ready to be queried
Type for API discovery results
Parameters for a single API
Parameters of the communication monitoring between EVerest and client
a beacon to indicate the API is ready to be queried