chargeflow

ChargeFlow

A CLI tool for analyzing your raw OCPP JSON messages. Useful for debugging and compatibility checks with various Charge Point Management Systems or Charge Point implementations.

Features

• Validate Raw OCPP JSON messages against multiple OCPP schemas
• Generate human-readable reports
• Support for remote schema registries using Kafka-compatible Schemas Registry APIs
• Bring your own OCPP schemas for vendor-specific extensions
• Validating OCMF-compatible meter values

Compatibility matrix

Roadmap

• Compatibility checks

Installation

Binary

Download the latest release for your platform from the releases page.

Linux / macOS

# Set your platform (linux or darwin) and architecture (amd64 or arm64)
OS=linux
ARCH=amd64

VERSION=$(curl -s https://api.github.com/repos/chargepi/chargeflow/releases/latest | grep '"tag_name"' | cut -d'"' -f4)
curl -L "https://github.com/chargepi/chargeflow/releases/download/${VERSION}/chargeflow_${VERSION#v}_${OS}_${ARCH}.tar.gz" | tar -xz chargeflow
sudo mv chargeflow /usr/local/bin/

Docker

docker pull ghcr.io/chargepi/chargeflow:latest

Run a command with Docker:

docker run --rm ghcr.io/chargepi/chargeflow:latest validate '[2, "123456", "BootNotification", {"chargePointVendor": "TestVendor", "chargePointModel": "TestModel"}]'

Usage

You can use ChargeFlow to validate OCPP messages by running the following command:

chargeflow validate '[2, "123456", "BootNotification", {"chargePointVendor": "TestVendor", "chargePointModel": "TestModel"}]'

For more options, you can run:

Usage:
  chargeflow [flags]
  chargeflow [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  schema      Manage schemas on a remote schema registry
  validate    Validate the OCPP message(s) against the registered OCPP schemas

Flags:
  -d, --debug            Enable debug mode
  -h, --help             help for chargeflow
  -m, --model string     Charging-station model for vendor/model-specific schema selection
  -V, --vendor string    Charging-station vendor for vendor/model-specific schema selection
  -v, --version string   OCPP version to use (1.6, 2.0.1 or 2.1) (default "1.6")

ChargeFlow will automatically determine whether it's a request or response message. All you need to provide is a OCPP version!

[!NOTE] If you want to validate a response message, you need to specify the response type using the --response-type flag.

Additionally, you can specify a custom path to vendor-specific OCPP schemas using the --schemas flag.

[!TIP] You can also validate multiple OCPP messages from a file using the -f flag. The file should be a newline-separated list of JSON strings.

For more detailed usage, see the documentation:

• Validating messages from a file
• Custom and vendor-specific schemas
• Remote schema registry

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

We welcome contributions to this project! Please read our contributing guidelines for more information on how to get started.