.. _everest_modules_error_history_consumer_API:

##########################
error_history_consumer_API
##########################
| API for accessing the error history (consumer API)


For a detailed handwritten documentation see :ref:`here <everest_modules_handwritten_error_history_consumer_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.

********
Provides
********
| **main**::ref:`generic_error <everest_interfaces_generic_error>`
|  Provides errors types for module communication status.

************
Requirements
************
| **error_history**::ref:`error_history <everest_interfaces_error_history>` 1

********
Metadata
********
Authors
=======
| Jan Christoph Habig
| Florin Mihut

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