OCPP 2.0.1 Actions
Full reference for every OCPP 2.0.1 message, one page each.
Messages
- Authorize — The Charging Station sends AuthorizeRequest to the CSMS to obtain authorization for an idToken before starting (or stopping) a transaction. OCPP 2.0.1 also supports authorization of EV Contract Cer…
- Boot Notification — After (re)boot, the Charging Station sends BootNotificationRequest to the CSMS containing the boot reason and Charging Station identification (vendor, model, serial, firmware, modem, …).
- Cancel Reservation — The CSMS sends CancelReservationRequest to cancel an active reservation on the Charging Station. The CS replies with status Accepted if a reservation matching reservationId exists; otherwise Rejected.
- Certificate Signed — The CSMS sends CertificateSignedRequest to deliver a signed PEM-encoded X.509 certificate (with sub-CA chain when applicable) to the Charging Station. The certificate is the result of the CSR previ…
- Change Availability — The CSMS sends ChangeAvailabilityRequest to set the operational status of either the whole Charging Station (when evse is omitted) or a specific EVSE/connector (when evse is provided) to Operative…
- Clear Cache — The CSMS sends ClearCacheRequest to ask the Charging Station to clear its Authorization Cache. The CS replies with Accepted if it executed the request, otherwise Rejected.
- Clear Charging Profile — The CSMS sends ClearChargingProfileRequest to remove either a specific charging profile (by chargingProfileId) or a selection of profiles matching evseId, stackLevel, and/or chargingProfilePurpose.
- Clear Display Message — The CSMS sends ClearDisplayMessageRequest to ask the Charging Station to remove a previously-configured display message identified by id.
- Clear Variable Monitoring — The CSMS sends ClearVariableMonitoringRequest to remove one or more variable monitors, identified by their monitor id. The CS replies with one ClearMonitoringResultType per requested id.
- Cleared Charging Limit — The Charging Station sends ClearedChargingLimitRequest to inform the CSMS that an externally-set charging limit (e.g. from EMS, SO/DSO, or local controller) has been cleared/released, so the CS is…
- Cost Updated — The CSMS sends CostUpdatedRequest to push the current running total cost of an ongoing transaction to the Charging Station. The CS uses this value to update its display for the EV driver.
- Customer Information — The CSMS sends CustomerInformationRequest to:
- Data Transfer (Charging Station → CSMS) — When the Charging Station needs to send vendor-specific information to the CSMS for functionality not covered by OCPP, it uses DataTransferRequest. The vendorId identifies the vendor-specific imple…
- Delete Certificate — The CSMS sends DeleteCertificateRequest to remove a specific installed certificate from the Charging Station. The target certificate is identified by its hash data (CertificateHashDataType).
- OCPP 2.0.1 Part 2 — Errata v2.0 — OCPP 2.0.1 OCPP 2.0.1 Part 2 — Errata v2.0 message reference.
- Firmware Status Notification — The Charging Station sends FirmwareStatusNotificationRequest to inform the CSMS about the progress of a firmware update started by UpdateFirmwareRequest (L01: signed firmware; L02: legacy non-signe…
- Get 15118 EV Certificate — When an ISO 15118 vehicle selects the CertificateInstallation (M01) or CertificateUpdate (M02) service, the Charging Station forwards the EV's CertificateInstallationReq to the CSMS encapsulated in…
- Get Base Report — The CSMS sends GetBaseReportRequest to ask the Charging Station for a base Device Model report — typically ConfigurationInventory (writable variables), FullInventory (everything), SummaryInventory…
- Get Certificate Status — The Charging Station sends GetCertificateStatusRequest to ask the CSMS for the OCSP status of an ISO 15118 / V2G-related certificate. This is typically used during EV authorization with contract ce…
- Get Charging Profiles — The CSMS sends GetChargingProfilesRequest to ask the Charging Station to report the charging profiles it currently has installed. The CS responds with GetChargingProfilesResponse(status) and then d…
- Get Composite Schedule — The CSMS sends GetCompositeScheduleRequest to ask the Charging Station for the composite schedule that results from combining all currently active charging profiles, local limits, and (where applic…
- Get Display Messages — The CSMS sends GetDisplayMessagesRequest to ask the Charging Station to report its currently-configured display messages. Filters by id, priority, and state narrow the result. The actual message da…
- Get Installed Certificate Ids — The CSMS sends GetInstalledCertificateIdsRequest to ask the Charging Station for an overview of installed certificates. Multiple certificate types can be requested in a single message; when certifi…
- Get Local List Version — The CSMS sends GetLocalListVersionRequest to retrieve the current version number of the Charging Station's Local Authorization List.
- Get Log — The CSMS sends GetLogRequest to ask the Charging Station to upload a log file (security or diagnostics) to a remote location. The CS responds with GetLogResponse(status, filename?) and then sends p…
- Get Monitoring Report — The CSMS sends GetMonitoringReportRequest to ask the Charging Station to report which monitors are currently configured for given components / variables. Filtering is by monitoringCriteria (up to 3…
- Get Report — The CSMS sends GetReportRequest to ask the Charging Station for a custom Device Model report — narrower than GetBaseReport. Filtering is by componentCriteria (up to 4) and/or by an explicit list of…
- Get Transaction Status — The CSMS sends GetTransactionStatusRequest to ask the Charging Station whether transaction-related messages are still queued for delivery. When transactionId is provided, only messages for that spe…
- Get Variables — The CSMS sends GetVariablesRequest to read one or more Device Model Variables synchronously. The response contains the result for each requested variable: actual/target/min/max value, attribute typ…
- Heartbeat — This use case describes a way to let the CSMS know the Charging Station is still connected: a Charging Station sends a heartbeat after a configurable time interval. Depending on the configuration…
- Install Certificate — The CSMS sends InstallCertificateRequest to install a root/CA certificate (V2G, MO, CSMS, or Manufacturer root) into the Charging Station's trust store.
- Log Status Notification — The Charging Station sends LogStatusNotificationRequest to inform the CSMS about the progress of a log file upload that was started by GetLogRequest. The CS sends one or more notifications during t…
- Meter Values — The Charging Station sends MeterValuesRequest to deliver one or more sampled meter readings not related to a transaction. For meter values inside a transaction, the CS uses TransactionEvent instead…
- Notify Charging Limit — The Charging Station sends NotifyChargingLimitRequest to communicate to the CSMS a charging limit that was set by an external system (e.g. EMS, SO/DSO, Local Controller) — not by the CSMS via SetCh…
- Notify Customer Information — After the CSMS sends CustomerInformationRequest (with report = true), the Charging Station replies with one or more NotifyCustomerInformationRequest messages containing the requested customer data…
- Notify Display Messages — After the CSMS sends GetDisplayMessagesRequest, the Charging Station replies with one or more NotifyDisplayMessagesRequest messages containing the matching display messages. The report can be split…
- Notify EV Charging Needs — When an EV connects via ISO 15118 and communicates its charging needs, the Charging Station forwards those needs to the CSMS using NotifyEVChargingNeedsRequest. This enables Central Smart Charging…
- Notify EV Charging Schedule — When the EV (via ISO 15118) calculates its own charging schedule and provides it to the Charging Station, the CS forwards that schedule to the CSMS via NotifyEVChargingScheduleRequest. This is typi…
- Notify Event — The Charging Station sends NotifyEventRequest to deliver Device Management monitoring events to the CSMS. Each event corresponds to a Component / Variable / VariableMonitoring triple where a config…
- Notify Monitoring Report — After the CSMS sends GetMonitoringReportRequest, the Charging Station replies with one or more NotifyMonitoringReportRequest messages containing the requested monitor configurations. Long reports a…
- Notify Report — After the CSMS sends GetBaseReportRequest or GetReportRequest, the Charging Station delivers the resulting Device Model report as a sequence of NotifyReportRequest messages. Each carries a chunk of…
- OCPP-J — JSON over WebSockets — OCPP 2.0.1 OCPP-J — JSON over WebSockets message reference.
- Publish Firmware — The CSMS sends PublishFirmwareRequest to a Local Controller (acting as Charging Station in the OCPP topology) instructing it to download a firmware file from a URI and republish it locally — so dow…
- Publish Firmware Status Notification — When a Local Controller has been asked to publish a firmware file (via PublishFirmwareRequest, used in setups with a Local Controller acting as firmware mirror for downstream Charging Stations), it…
- Report Charging Profiles — After the CSMS sends GetChargingProfilesRequest, the Charging Station reports the matching installed charging profiles using one or more ReportChargingProfilesRequest messages. The report can be sp…
- Request Start Transaction — The CSMS sends RequestStartTransactionRequest to ask the Charging Station to start a transaction. OCPP 2.0.1 replaces the OCPP 1.6 RemoteStartTransaction with this message and adds:
- Request Stop Transaction — The CSMS sends RequestStopTransactionRequest to ask the Charging Station to stop an ongoing transaction. The CS replies with Accepted/Rejected and, if accepted, drives the transaction to a normal s…
- Reservation Status Update — The Charging Station sends ReservationStatusUpdateRequest to inform the CSMS that a previously-made reservation has ended without being used (either because it expired, or because it became unusabl…
- Reserve Now — The CSMS sends ReserveNowRequest to ask the Charging Station to reserve an EVSE (or any EVSE matching connectorType) for a specific idToken until expiryDateTime.
- Reset — The CSMS sends ResetRequest to ask the Charging Station (or a specific EVSE) to perform a reset. OCPP 2.0.1 changes the reset semantics from Soft/Hard to Immediate vs OnIdle:
- Security Event Notification — The Charging Station sends SecurityEventNotificationRequest to inform the CSMS of a security-related event. The CSMS acknowledges with SecurityEventNotificationResponse (no body).
- Send Local List — The CSMS sends SendLocalListRequest to update the Charging Station's Local Authorization List. The update may be Full (replace) or Differential (apply changes).
- Set Charging Profile — The CSMS sends SetChargingProfileRequest to install a charging profile on the Charging Station. The profile applies to a specific EVSE — evseId = 0 carries an overall limit for the whole Charging S…
- Set Display Message — The CSMS sends SetDisplayMessageRequest to configure a display message on the Charging Station — either a generic message (O01), a message tied to a specific transaction (O02), or a replacement of…
- Set Monitoring Base — The CSMS sends SetMonitoringBaseRequest to set the base monitoring configuration on the Charging Station — i.e. which set of monitors is active by default (All, FactoryDefault, or HardWiredOnly).
- Set Monitoring Level — The CSMS sends SetMonitoringLevelRequest to configure the severity threshold below which the Charging Station reports monitoring events. Only events with severity ≤ severity are sent.
- Set Network Profile — The CSMS sends SetNetworkProfileRequest to configure or update a network connection profile in a specific configuration slot on the Charging Station. The profile contains the CSMS URL, OCPP version…
- Set Variable Monitoring — The CSMS sends SetVariableMonitoringRequest to install one or more monitors on Device Model variables. Each monitor specifies the threshold/delta value, a type (UpperThreshold, LowerThreshold, Delt…
- Set Variables — The CSMS sends SetVariablesRequest to write one or more Device Model variable attributes synchronously. The Charging Station returns one SetVariableResultType per variable, indicating success/failu…
- Sign Certificate — The Charging Station sends SignCertificateRequest to ask the CSMS (and ultimately the Certificate Authority) to sign its public key into a certificate. The public key is delivered as a Certificate…
- Status Notification — The Charging Station sends StatusNotificationRequest to inform the CSMS about a change of connector status (Available, Occupied, Reserved, Unavailable, Faulted).
- Transaction Event — TransactionEventRequest is the single message used in OCPP 2.0.1 to report the entire lifecycle of a transaction — replacing OCPP 1.6's StartTransaction, StopTransaction, and transaction-related Me…
- Trigger Message — The CSMS sends TriggerMessageRequest to ask the Charging Station to send a CS-initiated message on demand — typically used when the CSMS suspects its view of the CS state is stale (e.g. firmware up…
- Unlock Connector — The CSMS sends UnlockConnectorRequest to ask the Charging Station to unlock a specific connector. Used to help an EV driver whose cable retention has malfunctioned. If a transaction is in progress…
- Unpublish Firmware — The CSMS sends UnpublishFirmwareRequest to a Local Controller (acting as Charging Station in the OCPP topology) to remove a previously-published firmware file. The file is identified by its MD5 che…
- Update Firmware — The CSMS sends UpdateFirmwareRequest to instruct the Charging Station to download and install new firmware. OCPP 2.0.1 unifies the OCPP 1.6 UpdateFirmware and SignedUpdateFirmware into a single mes…