OCPP toolkit

The OCPP Toolkit lets you send commands directly to one of your chargers for troubleshooting. You can remotely unlock a stuck connector, restart a station, take a faulty plug out of service, check the charger's current configuration, and more. It's useful when you need to resolve an issue on the spot, without waiting for a driver or site owner to physically interact with the charger.

Which command do I need?

SituationCommand
A driver's cable is stuck and won't releaseUnlock connector
The charger is misbehaving and needs a restartReset
One plug is faulty but the rest of the charger worksChange availability
A charge won't start for a driver at the chargerRemote start transaction
A session is running that shouldn't beRemote stop transaction
You need to check how the charger is configuredGet configuration
You need to change a charger settingChange configuration
You're investigating an incident and need the charger's own dataGet diagnostics
The charger needs new firmwareUpdate firmware
A card or key works in the app but the charger rejects itClear cache

Opening the Toolkit

  1. Go to Charge points and open the list containing the charger you want to work with (Commercial chargers, Home chargers, or a specific location's charger list).
  2. Find the charger, open its row actions menu, and select Toolkit.
  3. The Toolkit opens in a new tab, already connected to that specific charger.

Each Toolkit session is temporary and tied to the charger you opened it from. If you need to work on a different charger, open the Toolkit again from that charger's row.

Access to the Toolkit is a permission your administrator can grant or restrict per admin account. If you don't see the Toolkit option, ask your administrator to enable it for your account.

Using the Toolkit

The Toolkit screen has two parts:

  • Command list (left): pick the action you want to perform.
  • Command log (right): every command you send is recorded here with a timestamp and its status (Sent, Received), along with the raw response from the charger. If a response hasn't arrived yet, use Refetch to check again.

Fill in the fields for the command you've selected and click Perform. The charger must be online to respond. If it doesn't answer, the Toolkit will let you know the station couldn't be reached.


Commands

Unlock connector

Remotely releases a connector's physical cable lock, by connector ID. This is the fix when a plug is stuck and a driver can't remove their cable, which is one of the most common support calls. If the connector stays locked after the command succeeds, a hard Reset is the usual next step.

Reset

Restarts the charger. Two kinds:

  • Soft reset restarts the charge point application. Try this first; it does not cut power.
  • Hard reset power-cycles the whole unit and will interrupt any session in progress. Use it when a soft reset isn't enough.

Change availability

Sets a connector to Operative or Inoperative, taking it in or out of service. Use it to temporarily block a single faulty plug while the charger's other plugs keep serving drivers, without removing the charger from your network. Set it back to Operative once the plug is fixed.

Remote start transaction

Starts a charging session on a specific connector on behalf of a driver, using an ID tag you provide. Useful when a driver at the charger can't start a charge themselves.

Remote stop transaction

Stops an active charging session by its transaction ID.

Get configuration

Reads back the charger's current settings. Pick one or more keys from the standard list, or type a custom key name. You can queue up several keys before submitting a single request.

Change configuration

Sets an OCPP configuration key on the charger, such as HeartbeatInterval, MeterValuesSampledData, or WebSocketPingInterval. Pick a key from the list, or use the Custom key option to enter your own, then provide the value.

Get diagnostics

Asks the charger to upload a diagnostics file to a location you specify (an HTTP or FTP URL). You can set a start time and stop time for the data, plus the number of retries and the retry interval in seconds. Useful when investigating a specific incident.

Update firmware

Instructs the charger to retrieve firmware from a URL you specify, on a retrieve date you set, with a number of retries and a retry interval in seconds.

Clear cache

A single click clears the charger's local authorization cache, forcing it to re-check credentials with the backend. Try this when a card or key that should work keeps being rejected at the charger.

Get local list version

A single click returns the version number of the local authorization list currently stored on the charger.

Send local list

Pushes a new or updated local authorization list to the charger. You set the list version number, choose a Full update (the entire list) or a Differential update (only the changes since the last update), and add one or more ID tag entries. Each entry has its own status (Accepted, Blocked, Expired, Invalid, or ConcurrentTx), an expiry date, and an optional parent ID tag.

Trigger message

Asks the charger to send (or resend) a specific message for a given connector ID: BootNotification, DiagnosticsStatusNotification, FirmwareStatusNotification, Heartbeat, MeterValues, or StatusNotification. Useful when you suspect the platform's view of the charger is stale and want a fresh report.

Data transfer

Sends a custom vendor-specific payload (vendor ID, message ID, and free-text data) directly to the charger. Intended for vendor-specific diagnostics and advanced troubleshooting.

Clear charging profile

Removes a previously set smart-charging profile from the charger, identified by its profile ID, connector ID, and stack level.

Reservation commands (reserving a connector and cancelling a reservation) are temporarily unavailable in the Toolkit.


Things to be aware of

  • A Hard reset will interrupt any session currently in progress on that charger. Only use it if the situation calls for a full restart.
  • Update firmware and Get diagnostics are asynchronous. The charger fetches or uploads on its own schedule, so the immediate response only confirms the request was accepted, not that the task is finished.
  • All commands require the charger to be online and reachable. If the charger shows as Offline in Charge points, no Toolkit command will go through until it reconnects.

Common Questions

How do I unlock a cable that is stuck in the charger?
Open the charger's Toolkit and use Unlock connector with the affected connector's ID. If the lock doesn't release, follow up with a Reset (hard, if a soft reset doesn't do it).

How do I restart a charger remotely?
Use Reset in the Toolkit. Start with a Soft reset; use a Hard reset only if needed, since it cuts power and interrupts any running session. For a plain restart without opening the Toolkit, the charger's row menu in Charge points also has a Reboot action.

How do I disable one plug without taking down the whole charger?
Use Change availability to set that connector to Inoperative. The charger's other plugs keep working. Set it back to Operative after the repair.

A driver's card or key is rejected at the charger but looks fine in Spark. What now?
Use Clear cache so the charger re-checks credentials with the backend instead of trusting its local list. If the problem persists, check the local authorization list with Get local list version and correct it with Send local list.

Why doesn't the charger respond to my command?
The charger must be online. Check its status in Charge points; if it shows Offline, the command cannot reach it until its connection is restored.



Did this page help you?