ocpp-kit

The ocpp-cli tool

Validate a payload, explain an OCPP-J frame, replay a capture in CI, browse the action catalogue, and run a mock CSMS or charging station.

$ cargo install ocpp-kit --features cli

A small tool for the things you end up doing by hand: reading a capture, checking a payload, and standing up a peer to talk to.

actions — the catalogue

$ ocpp-cli actions --version 2.1 --block S
ACTION                               BLOCK                    KIND    DIRECTION
BatterySwap                          S                        CALL    CS  -> CSMS
RequestBatterySwap                   S                        CALL    CSMS -> CS

2 action(s) in OCPP 2.1

--block filters by functional block (2.x: A–S) or feature profile (1.6: Core, Security, …).

validate — check one payload

$ echo '{"reason":"PowerUp","chargingStation":{"model":"M1","vendorName":"ACME"}}' \
    | ocpp-cli validate --action BootNotification
{
  "chargingStation": {
    "model": "M1",
    "vendorName": "ACME"
  },
  "reason": "PowerUp"
}
ok: valid BootNotificationRequest for OCPP 2.1

What it prints is what the Rust types modelled, so a member that came out missing is a member the types do not carry. When it fails, it names the code you should have answered with:

$ echo '{"reason":"PowerUp","chargingStation":{"model":"a-model-name-that-is-far-too-long","vendorName":"ACME"}}' \
    | ocpp-cli validate --action BootNotification
error: /chargingStation/model: maxLength 20 exceeded (got 33 characters)
  OCPP error code: PropertyConstraintViolation
  path: /chargingStation/model

Add --response for a response payload, --version 1.6 for another version, and --lenient / --pedantic to change the decoding policy.

frame — explain one OCPP-J frame

$ echo '[2,"1","BootNotification",{"reason":"PowerUp","chargingStation":{"model":"M1","vendorName":"ACME"}}]' \
    | ocpp-cli frame
CALL 1 BootNotification [ChargingStation] valid

The payload is checked against the types, not merely parsed.

replay — check a whole capture

A capture is one frame per line; a leading > or < marking direction is ignored, and # starts a comment.

$ ocpp-cli replay session.ocppcap --version 2.1
    1: CALL 19223201 BootNotification [ChargingStation] valid
    2: CALLRESULT 19223201 (78 bytes) — the action is only known from the matching CALL
    3: CALL 19223202 StatusNotification [ChargingStation] INVALID: /timestamp: …

3 frame(s), 1 problem(s)

Exit status is non-zero when anything did not check out, so it drops into CI.

signed — read a signed meter value the way a CSMS has to

Both fields of a SignedMeterValueType hide something: signedMeterData is specified as Base64 but is often sent as OCMF|… text, and publicKey is specified as an oca: envelope but is often sent as Base64 over plain hexadecimal. Getting either wrong is quiet — the station keeps sending and its sessions stop being billable — so this is the loop for finding out what a particular station does before writing an integration around a guess.

$ ocpp-cli signed --key MzA1OTMwMTMwNjA3MkE4NjQ4Q0UzRDAyMDEwNjA4MkE4NjQ4Q0UzRDAzMDEwNw==
publicKey:      23 bytes, sent as PrintedHex
  printed:      3059301306072A8648CE3D020106082A8648CE3D030107
  hex:          3059301306072A8648CE3D020106082A8648CE3D030107
note: the key is what the station *claims*. Verify against one obtained out of band.

$ echo '{"signedMeterData":"T0NNRnx7fQ==","encodingMethod":"OCMF"}' | ocpp-cli signed
encodingMethod: OCMF
signingMethod:  <absent>
record:         7 bytes, OCMF text

OCMF|{}
publicKey:      absent

It takes the 1.6 SignedData value string as readily as the 2.x object — including with its JSON quoting still on, which is how it comes out of a capture. See signed meter values.

csms and station — mock peers

$ ocpp-cli csms --bind 127.0.0.1:9000
mock CSMS listening on 127.0.0.1:9000
station CS-0001 connecting from 127.0.0.1:54119 (security profile 1)
+ CS-0001 (OCPP 2.1)

$ ocpp-cli station --url ws://127.0.0.1:9000/ocpp --identity CS-0001
boot: Accepted, interval 300s

Both refuse every action they are asked for, which is the point: they exist to check connectivity, negotiation and authentication, not to pretend to implement the protocol.

An unknown option is an error, as is one given without its value — a mistyped --pedantic would otherwise report a payload as valid under rules you asked not to use.

In a checkout

The same family of question, answered by cargo xtask:

$ cargo xtask coverage                       # requirement IDs cited by the source and tests
$ cargo xtask coverage --block B02           # …just one block
$ cargo xtask coverage --profile core        # how much of a certification profile is driven
$ cargo xtask schema-report                  # actions, enums and types per version and block
$ cargo xtask no-floats                      # fail if an f32/f64 reaches a public signature
$ cargo xtask ci                             # run what CI runs, before pushing — the
                                             #   commands *and* the workflow's env, so
                                             #   `-D warnings` means the same thing here

Edit this page on GitHub