ocppsim 0.1.1

A terminal OCPP-J charge point simulator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# ocppsim

`ocppsim` is a terminal OCPP-J (Open Charge Point Protocol JSON) charge point
simulator written in Rust.
It connects to a CSMS over WebSocket, negotiates an OCPP subprotocol, and lets
an operator drive common charge point workflows from an interactive terminal UI.

The simulator is focused on practical protocol development and CSMS testing.
It keeps local connector, transaction, meter, reservation, charging profile, and
configuration state, then emits protocol-shaped OCPP messages from that state.

## Installation

- Cargo

  ```sh
  cargo install ocppsim
  ```

- Homebrew

  ```sh
  brew install zhongruoyu/tap/ocppsim
  ```

- Prebuilt binaries

  Download prebuilt binaries for Linux, macOS, and Windows from `ocppsim`'s
  [latest release](https://github.com/ZhongRuoyu/ocppsim/releases/latest) on
  GitHub.

- Docker

  Docker images for `ocppsim` are also available on Docker Hub as
  [`zhongruoyu/ocppsim`](https://hub.docker.com/r/zhongruoyu/ocppsim),
  and on GitHub Container Registry as
  [`ghcr.io/zhongruoyu/ocppsim`](https://ghcr.io/zhongruoyu/ocppsim).
  Use the `latest` tag or a specific version tag like `v0.1.0` to track stable
  releases, and `main` to track the latest commit on the main branch.

## Quick Start

Run `ocppsim` directly against a CSMS endpoint:

```sh
ocppsim --ws-url ws://csms.example.com/ocpp --cp-id CP-001
```

Or use a named profile from a [TOML config file](docs/usage.md#configuration)
in `~/.config/ocppsim/ocppsim.toml` or a custom path:

```sh
ocppsim some-profile
ocppsim some-profile --config-path ./ocppsim.toml
```

In a Docker container, you can run `ocppsim` with a mounted config file like:

```sh
docker run --rm -it \
  -v "$PWD/ocppsim.toml:/config/ocppsim.toml:ro" \
  zhongruoyu/ocppsim some-profile --config-path /config/ocppsim.toml
```

Run `ocppsim --help` for more CLI options.
Inside the terminal UI, type `help` to see available simulator commands.
See [documentation](docs/usage.md) for more details on usage.

[Shell completion](docs/usage.md#shell-completion) can be enabled by adding the
relevant command to your shell profile:

```sh
# Bash
source <(ocppsim completions bash)
# Zsh
source <(ocppsim completions zsh)
# Fish
ocppsim completions fish | source
# PowerShell
ocppsim completions powershell | Out-String | Invoke-Expression
```

## Documentation

Documentation on design, protocol support, usage, and more is available in the
[`docs`](docs/README.md) directory.

## Protocol Scope

OCPP 1.6 base JSON schemas are the primary complete target.
The OCPP 1.6 Security Whitepaper extension is intentionally out of scope for
now and is reported as unsupported when recognized.

OCPP 2.0.1 and OCPP 2.1 support the feature subset that maps to already
implemented OCPP 1.6 behavior, plus `GetVariables` and `SetVariables` for the
configuration-equivalent device model surface.
Other 2.x actions are explicitly treated as unsupported until they are
implemented and tested.

Schema validation tests use files under [`schemas`](schemas/README.md) as the
source of truth.

## License

This project is licensed under the MIT License.
See [LICENSE](./LICENSE) for details.