refactor: refine OCPP 2 mock server defaults
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md
1 # OCPP2 Mock Server
2
3 This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock server implemented in Python.
4
5 ## Prerequisites
6
7 This project requires Python 3.7+ and the following Python packages:
8
9 - `websockets`
10 - `ocpp`
11
12 You can install these packages using pip:
13
14 ```
15 pip install websockets ocpp
16 ```
17
18 ## Running the Server
19
20 To start the server, run the `server.py` script:
21
22 ```
23 python server.py
24 ```
25
26 The server will start listening for connections on port 9000.
27
28 ## Overview of the Server Scripts
29
30 ### Server.py
31
32 The 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.
33
34 The server script uses the websockets and ocpp libraries to facilitate the WebSocket and OCPP communication.
35
36 ## Note
37
38 Primarily, 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.
39
40 For reference:
41 https://github.com/mobilityhouse/ocpp