system_API¶
API for system modules
Handwritten Documentation¶
The complete API specification can be found in the
docs/source/reference/EVerest_API/system_API.yaml
file in the source repository, or in the AsyncAPI HTML documentation automatically generated from it.
Auto-Generated Reference¶
Module Configuration¶
cfg_communication_check_to_s: integer <optional>
default: 5
Maximum time between two communication check events. Values <= 0 disables communication checks.
cfg_heartbeat_interval_ms: integer <optional>
default: 1000
Interval between two heartbeat messages send by the API. Values <= 0 disable heartbeat.
cfg_request_reply_to_s: integer <optional>
default: 550
Maximum time between request and reply. After timeout the request is answered with a default response.
Provides¶
main: system
Allows EVerest to access system wide operations via API clients.