Merge branch 'main' into issue39-ocpp2

[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 1b642475d36757c63689628c43db2e8823fe13ce..e6a4dfa180791a9c62293c160f1127b06b3b4332 100644 (file)
--- a/tests/ocpp-server/README.md
+++ b/tests/ocpp-server/README.md
@@ -1,18 +1,11 @@
 # 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
 ```
@@ -25,13 +18,29 @@ To start the server, run the `server.py` script:
 poetry run task server
 ```
 
-or
+The server will start listening for connections on port 9000.
+
+## Running the server with command sending
+
+You can also specify a command and a period duration with the --request and --period options respectively when running the server. The server will then send your chosen command to the connected client every period seconds.
+
+### GetBaseReport Command
+
+To run the server and send a GetBaseReport command every 5 seconds, use:
 
 ```shell
-poetry run task server --request GetBaseReport --period 5
+poetry run task server --command GetBaseReport --period 5
 ```
 
-The server will start listening for connections on port 9000.
+### 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 server.
 
 ## Overview of the Server Scripts