test: add ConfigurationData enums tests

[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md

diff --git a/tests/ocpp-server/README.md b/tests/ocpp-server/README.md
index e02d8b7bdb2bf400ba7c3942903e31cc22853376..32e136196b9fb2eba197b78001ed235897d95656 100644 (file)
--- a/tests/ocpp-server/README.md
+++ b/tests/ocpp-server/README.md
@@ -1,40 +1,72 @@
 # OCPP2 Mock Server
 
-This project includes a mock Open Charge Point Protocol (OCPP) version 2.0.1 server implemented in Python.
+This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock server implemented in Python.
 
 ## Prerequisites
 
-This project requires Python 3.7+ and the following Python packages:
+This project requires Python 3.7+ and [poetry](https://python-poetry.org/) to install the required packages:
 
-- `websockets`
-- `ocpp`
-
-You can install these packages using pip:
-```
-pip install websockets ocpp
+```shell
+poetry install
 ```
 
 ## Running the Server
 
 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.
 
+## Running the server with OCPP command sending
+
+You can also specify a command and a period duration with the --command and --period options respectively when running the server. The server will then send your chosen command to the connected client(s) every period seconds.
+
+### GetBaseReport Command
+
+To run the server and send a GetBaseReport command every 5 seconds, use:
+
+```shell
+poetry run task server --command GetBaseReport --period 5
+```
+
+### ClearCache Command
+
+To run the server and send a ClearCache command every 5 seconds, use:
+
+```shell
+poetry run task server --command ClearCache --period 5
+```
+
+Please be mindful that these commands were examples according to the provided scenario, the available commands and their syntax might vary depending on the ocpp version and the implemented functionalities on your client.
+
 ## Overview of the Server Scripts
 
 ### 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
 
-The server script uses the websockets and ocpp libraries to facilitate the WebSocket and OCPP communication.
+### Code formatting
+
+```shell
+poetry run task format
+```
+
+### Code linting
+
+```shell
+poetry run task lint
+```
 
 ## Note
 
-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.
+Primarily, this software is intended for testing applications. The server script don't adhere to the full OCPP specifications and it is advised not to use them in a production environment without additional development.
 
 For reference:
 https://github.com/mobilityhouse/ocpp