.. _everest_modules_system_API:

##########
system_API
##########
| API for system modules


For a detailed handwritten documentation see :ref:`here <everest_modules_handwritten_system_API>`

********************
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**::ref:`system <everest_interfaces_system>`
|  Allows EVerest to access system wide operations via API clients.


********
Metadata
********
Authors
=======
| James Chapman
| Cornelius Claussen
| Jan Christoph Habig
| Florin Mihut

License
=======
| https://opensource.org/licenses/Apache-2.0