chore(deps-dev): apply updates
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md
index 544af2b727c81d1933d80f7e7d285965694eb4bb..32e136196b9fb2eba197b78001ed235897d95656 100644 (file)
@@ -1,21 +1,15 @@
 # OCPP2 Mock Server
 
 This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock server implemented in Python.
-https://github.com/mobilityhouse/ocpp/blob/master/ocpp/v201/enums.py
 
 ## Prerequisites
 
 This project requires Python 3.7+ and [poetry](https://python-poetry.org/) to install the required packages:
-```shell
-pip install poetry
-```
-then
 
 ```shell
 poetry install
 ```
 
-
 ## Running the Server
 
 To start the server, run the `server.py` script:
@@ -23,12 +17,30 @@ To start the server, run the `server.py` script:
 ```shell
 poetry run task server
 ```
-or
+
+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 --request GetBaseReport --period 5
+poetry run task server --command ClearCache --period 5
 ```
-The server will start listening for connections on port 9000.
+
+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