evse_manager_consumer_API¶
API for using EVSE manager (consumer API)
Handwritten Documentation¶
The complete API specification can be found in the
docs/source/reference/EVerest_API/evse_manager_consumer_API.yaml
file in the source repository, or in the AsyncAPI HTML documentation automatically generated from it.
Session Info¶
This API module additionally provides a SessionInfo class to represent information about EVSE sessions.
The data for SessionInfo is not simply forwarded from the internal EVerest representation. The internal
represenation is processed and converted to the external API representation.
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: generic_error
Provides errors types for module communication status.
Requirements¶
evse_manager: evse_manager 1
evse_bsp: evse_board_support 0..1
slac: slac 0..1
imd: isolation_monitor 0..1
ps_dc: power_supply_DC 0..1
random_delay: uk_random_delay 0..1