build(deps-dev): apply updates
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md
index 332751d564533331cc43d066ca343ec15a16d231..b0ddd9b7d3857c8c15878a2ff43a9b35f766a71b 100644 (file)
@@ -6,7 +6,7 @@ This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock se
 
 This project requires Python 3.7+ and [poetry](https://python-poetry.org/) to install the required packages:
 
-```
+```shell
 poetry install
 ```
 
@@ -14,8 +14,8 @@ poetry install
 
 To start the server, run the `server.py` script:
 
-```
-python server.py
+```shell
+poetry run task server
 ```
 
 The server will start listening for connections on port 9000.
@@ -24,9 +24,23 @@ The server will start listening for connections on port 9000.
 
 ### Server.py
 
-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.
+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 messages, most of which return a dummy response.
+
+The server script uses the `websockets` and `ocpp` libraries to facilitate the implementation.
+
+## Development
+
+### Code formatting
 
-The server script uses the websockets and ocpp libraries to facilitate the WebSocket and OCPP communication.
+```shell
+poetry run task format
+```
+
+### Code linting
+
+```shell
+poetry run task lint
+```
 
 ## Note