Merge pull request #1041 from syuusei3/issue39-ocpp2
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md
CommitLineData
fa16d389
S
1# OCPP2 Mock Server
2
3This project includes a mock Open Charge Point Protocol (OCPP) version 2.0.1 server implemented in Python.
4
5## Prerequisites
6
7This project requires Python 3.7+ and the following Python packages:
8
9- `websockets`
10- `ocpp`
11
12You can install these packages using pip:
13```
14pip install websockets ocpp
15```
16
17## Running the Server
18
19To start the server, run the `server.py` script:
20
21```
22python server.py
23```
24
25The server will start listening for connections on port 9000.
26
27## Overview of the Server Scripts
28
29### Server.py
30
31The server script waits for connections from clients. When a client connects, the server creates a new instance of the `ChargePoint` class. This class includes methods for handling various OCPP actions (`BootNotification`,`GetBaseReport`), most of which return a dummy response. The `GetBaseReport` method prints the received request and returns a simple confirmation message.
32
33The server script uses the websockets and ocpp libraries to facilitate the WebSocket and OCPP communication.
34
35## Note
36
37Primarily, this software is intended for testing applications. The server scripts don't execute full OCPP adherence and it is advised not to use them in a production environment without additional development.
38
39For reference:
40https://github.com/mobilityhouse/ocpp