Reference

OCPPClient

OCPP WebSocket client for connecting to a Central System (CSMS). Supports OCPP 1.6 and 2.0.1 with typed request/response handling.

ChargePoint(id, url; spec=OCPPData.V16.Spec(), reconnect=true,
            reconnect_interval=5.0)

Create a ChargePoint. Does not connect yet — call connect! to start.

Emit a ClientEvent to all registered listeners.

Convert a Dict payload back to a typed struct.

_handle_server_call(cp::ChargePoint, call::OCPPData.Call)

Dispatch an incoming server Call to the registered handler and return a CallResult or CallError.

Read messages from the WebSocket and dispatch them.

Send a typed request and return the typed response. Throws OCPPCallError if the server returns a CallError.

Convert a typed struct to a Dict{String,Any} payload with camelCase keys.

transaction_event(cp; event_type, seq_no, timestamp, transaction_info,
                  trigger_reason, kwargs...)

Send a TransactionEvent (V201 only). Throws OCPPVersionError for V16. Required kwargs:

• event_type::OCPPData.V201.TransactionEvent — Started, Updated, or Ended
• seq_no::Int — sequence number (monotonically increasing per transaction)
• transaction_info::OCPPData.V201.Transaction — transaction details
• trigger_reason::OCPPData.V201.TriggerReason — reason for this event

authorize(cp; kwargs...)

Send an Authorize request.

V16 kwargs: id_tag::String

V201 kwargs: id_token::OCPPData.V201.IdToken

boot_notification(cp; kwargs...)

Send a BootNotification. Dispatches to V16 or V201 based on cp.spec.

V16 kwargs: charge_point_vendor::String, charge_point_model::String

V201 kwargs: reason::OCPPData.V201.BootReason, charging_station::OCPPData.V201.ChargingStation

connect!(cp::ChargePoint)

Connect to the CSMS WebSocket server. Blocks while connected; use with @async or Threads.@spawn. Automatically reconnects on disconnect if cp.reconnect is true.

disconnect!(cp::ChargePoint)

Disconnect from the CSMS. Disables auto-reconnect before closing.

heartbeat(cp; timeout=30.0)

Send a Heartbeat. Returns a version-appropriate HeartbeatResponse.

meter_values(cp; kwargs...)

Send MeterValues.

V16 kwargs: connector_id::Int, meter_value::Vector{OCPPData.V16.MeterValue}

V201 kwargs: evse_id::Int, meter_value::Vector{OCPPData.V201.MeterValue}

on!(cp::ChargePoint, action::String, handler::Function)

Register a handler for a server-initiated action (e.g., Reset). Signature: handler(cp::ChargePoint, request) → response_payload

send_call(cp::ChargePoint, action::String, payload::Dict{String,Any};
          timeout::Float64=30.0)

Send an OCPP Call to the CSMS and block until a response is received or the timeout expires. Returns the OCPPData.OCPPMessage (CallResult or CallError).

start_transaction(cp; connector_id, id_tag, meter_start, timestamp, kwargs...)

Send a StartTransaction (V16 only). Throws OCPPVersionError for V201 — use transaction_event instead.

status_notification(cp; kwargs...)

Send a StatusNotification.

V16 kwargs: connector_id::Int, status::OCPPData.V16.ChargePointStatus, error_code::OCPPData.V16.ChargePointErrorCode

V201 kwargs: connector_id::Int, connector_status::OCPPData.V201.ConnectorStatus, evse_id::Int, timestamp::String (optional, defaults to now)

stop_transaction(cp; transaction_id, meter_stop, timestamp, kwargs...)

Send a StopTransaction (V16 only). Throws OCPPVersionError for V201 — use transaction_event instead.

subscribe!(cp::ChargePoint, callback::Function)

Subscribe to ClientEvents. Signature: callback(event::ClientEvent).

transaction_event(cp; event_type, seq_no, transaction_info, trigger_reason,
                  timestamp, kwargs...)

Send a TransactionEvent (V201 only). Throws OCPPVersionError for V16 — use start_transaction/stop_transaction instead.