Update tests/ocpp-server/server.py
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md
index e2a8149c90de427c31db970401e41df9f69377e0..e4a810d8a7c25f2bd37529cdc470d3fe86f62de0 100644 (file)
@@ -15,18 +15,42 @@ poetry install
 To start the server, run the `server.py` script:
 
 ```shell
-python server.py
+poetry run task server
 ```
 
 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
+```
+
+=======
+
+### ClearCache Command
+
+To run the server and send a ClearCache command every 5 seconds, use:
+
+```shell
+poetry run task server --request 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
 
 ### 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 WebSocket and OCPP communication.
+The server script uses the `websockets` and `ocpp` libraries to facilitate the implementation.
 
 ## Development