- Getting started
- Quickstart
Quickstart
Get from zero to a connected charge point and a visible session in the Dashboard in under an hour.
This quickstart takes you from a new Dashboard org to a live OCPP session. You need network access from a charge point (or simulator) to the OCPPLab OCPP endpoint.
Goals
By the end you will have:
- An organization in Dashboard
- A registered charge point pointed at OCPPLab
- A successful
BootNotificationand an online station - At least one completed test session
Prerequisites
- Dashboard access for your tenant
- Either a real charger or the simulator guide
- Outbound WebSocket (TLS preferred) from the station to OCPPLab
Never paste live OCPP passwords, OCPI tokens, or client certificates into tickets, chat, or public issues. Rotate anything that may have been exposed and use Dashboard or your secret store for operational credentials.
Steps
Create or join an organization
Sign in to the Dashboard and complete org onboarding. Chargers, sessions, roaming partners, and webhooks are all tenant-scoped.
Register a charge point
In Dashboard, open Add charger and fill every field (identity, OCPP version, brand, model, connectors). Full field guide: Create a charger.
Value Where you use it Charge point identity OCPP chargePointId/ station id on the deviceOCPP endpoint URL CSMS URL on the charger or simulator Security profile TLS, basic auth, or certificate profile as configured for the org Point the charger at OCPPLab
Configure the station CSMS URL to the OCPPLab OCPP gateway for your environment. Prefer TLS and the highest security profile your hardware supports. See Connect a charger for a full checklist.
Copy the live endpoint from Dashboard
Example hosts such as
ocpp.example.comare shape only. Open the charger in Dashboard (Managed chargers → select the station, or the create-charger success view) and copy the OCPP / CSMS URL shown for that identity. Paste that value into the station or simulator — do not invent the hostname from these docs.# Shape only — paste the URL copied from Dashboard charger detail wss://ocpp.example.com/<org-or-env>/<charge-point-id>Confirm BootNotification
When the station connects, Dashboard should show it online. If it stays offline:
- Confirm WebSocket reachability and TLS trust
- Match the charge point id exactly to Dashboard
- Check observability / message logs for
BootNotificationrejects
Run a test session
Start a session from the station or via remote start (when authorized). Confirm:
- Session appears under charge sessions
- Meter values update (if enabled on the station)
- Stop is clean and energy totals look sane
Example configs
Sample station and auth shapes (illustrative — use values from the Dashboard):
{
"chargePointId": "CP001",
"ocppVersion": "1.6",
"csmsUrl": "wss://ocpp.example.com/env/CP001"
}Protocol depth (optional next)
| Topic | Guide |
|---|---|
| Full OCPP library | OCPP docs — 1.6 and 2.0.1 actions + test cases |
| Roaming | OCPI docs — credentials and modules |
| Product surface | Dashboard · Webhooks |
Next steps
- Concepts — CPO, eMSP, OCPP vs OCPI
- Connect a charger — production connection checklist
- Multi-backend routing — dual-run and cutover
- OCPI credentials — roaming handshake