X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=tests%2Focpp-server%2FREADME.md;h=bb5d5b17ff3eeac70e204f3732b44eaec6e0c966;hb=3a89ffcba5b6eb9e37619f67b56aadfea2ee2a09;hp=e02d8b7bdb2bf400ba7c3942903e31cc22853376;hpb=fa16d389b8eb171e581c3fe5789602c54ac85ab1;p=e-mobility-charging-stations-simulator.git diff --git a/tests/ocpp-server/README.md b/tests/ocpp-server/README.md index e02d8b7b..bb5d5b17 100644 --- a/tests/ocpp-server/README.md +++ b/tests/ocpp-server/README.md @@ -1,25 +1,21 @@ # 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. @@ -32,9 +28,23 @@ The server script waits for connections from clients. When a client connects, th The server script uses the websockets and ocpp libraries to facilitate the WebSocket and OCPP communication. +## Development + +### 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