evse_security_consumer_API¶
API for evse_security (consumer API)
Handwritten Documentation¶
Warning
This API module is currently experimental: its AsyncAPI channels, operations and message payloads may change without further notice. It is exempt from the stability guarantees and the deprecation period of the EVerest public API until promoted to stable (see Experimental Components).
The complete API specification can be found in the
docs/source/reference/EVerest_API/evse_security_consumer_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.
Provides¶
main: generic_error
Provides generic errors for communication check
Requirements¶
evse_security: evse_security 1