ocpp_consumer_API

API for OCPP (consumer API)

Handwritten Documentation

The complete API specification can be found in the

docs/source/reference/EVerest_API/ocpp_consumer_API.yaml

file in the source repository, or in the AsyncAPI HTML documentation automatically generated from it.

Variable addressing

get_variables / set_variables / monitor_variables use canonical component/variable addressing (e.g. component OCPPCommCtrlr, variable HeartbeatInterval), identical for OCPP 1.6 and 2.x. The OCPP 1.6 key-only form (empty component.name, variable.name = configuration key) is deprecated: it is only accepted while OCPP 1.6 is active and will be removed per the deprecation policy. See the “Configuration access” and “Migration from OCPP 1.6 key addressing” sections in the OCPPmulti module documentation (everest_modules_handwritten_OCPPmulti) for examples and the migration guide.

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.

latch_variable_values: boolean <optional>

default: True

Determines whether variables published by this module are cached and made available for get requests.

Provides

main: ocpp_data_transfer

Allows API clients to provide processed OCPP data transfers to EVerest.

generic_error: generic_error

Provides errors types for module communication status.

Requirements

ocpp: ocpp 1

data_transfer: ocpp_data_transfer 1

Metadata

Authors

James Chapman

Jan Christoph Habig

Florin Mihut

License

https://opensource.org/licenses/Apache-2.0