Skip to content

Commit d2e96fc

Browse files
author
JIMENEZ Cédric
committed
[readme] Add missing dependencies
1 parent 0a8d858 commit d2e96fc

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ These 3 applications are communicating using the MQTT protocol and the simulated
2323
### Pre-requisites
2424

2525
* Open OCPP library (see [Build and installation procedure](https://github.com/c-jimenez/open-ocpp#build))
26+
* [Paho MQTT library](https://www.eclipse.org/paho/) 1.3.8 or greater
2627
* Python 3.8 or greater with the following packages : kivy, paho-mqtt
2728
* [Mosquitto MQTT broker](https://mosquitto.org/) 2.0.11 or greater
2829

@@ -31,12 +32,12 @@ For information, most of the development has been made on the following environm
3132
* Debian 11 (Bullseye)
3233
* gcc 10.2 and clang 11.0
3334
* Python 3.9
34-
* Mosquitto 2.0.11
35+
* Mosquitto 2.0.11
3536

3637
On Debian the pre-requisites (except for Open OCPP) can be installed using the following commands:
3738

3839
```
39-
sudo apt install python3 mosquitto
40+
sudo apt install python3 python3-pip mosquitto libpaho-mqtt-dev
4041
python3 -m pip install kivy paho-mqtt
4142
```
4243

@@ -52,7 +53,7 @@ Additionnaly, the **CMakeLists_Options.txt** contains several options that can b
5253

5354
An helper makefile is available at project's level to simplify the use of CMake. Just use the one of the following commands to build using gcc or gcc without cross compilation :
5455

55-
```make gcc-native``` or ```make clang-native``` or ```make gcc-native BUILD_TYPE=Debug``` or ```make clang-native BUILD_TYPE=Debug```
56+
```make gcc-native``` or ```make clang-native``` or ```make gcc-native BUILD_TYPE=Debug``` or ```make clang-native BUILD_TYPE=Debug```
5657

5758
This makefile also contains the corresponding cleaning targets :
5859

@@ -193,7 +194,7 @@ cp_simu
193194
| | | | |-car
194195
| | | | |-id_tag
195196
| | | | |-status
196-
```
197+
```
197198

198199
The simulation environment takes advantage of 2 MQTT features :
199200

@@ -203,7 +204,7 @@ The simulation environment takes advantage of 2 MQTT features :
203204
To remove a simulated Charge Point from the simulation environment, use the following protocol :
204205

205206
* Kill the simulated Charge Point instance through the **launcher** API
206-
* Remove the retained status of the simulated Charge Point and its connectors in the MQTT broker by sending a retained message with an empty payload on their status topics
207+
* Remove the retained status of the simulated Charge Point and its connectors in the MQTT broker by sending a retained message with an empty payload on their status topics
207208

208209
### Launcher API
209210

@@ -239,7 +240,7 @@ Payload :
239240
{
240241
"type": "kill",
241242
"charge_points": [
242-
{ "id": "simu_cp_XXX" },
243+
{ "id": "simu_cp_XXX" },
243244
{ "id": "simu_cp_YYY" }
244245
]
245246
}
@@ -301,7 +302,7 @@ The status message has the following payload :
301302
Each connector of the simulated Charge Point are listening to the following topic to simulate interaction with a car : **cp_simu/cps/simu_cp_XXX/connectors/N/car** where **N** stands for the connector number.
302303

303304
The expected command payload is :
304-
305+
305306
```
306307
{
307308
"cable": 32,
@@ -313,7 +314,7 @@ The expected command payload is :
313314
Each connector of the simulated Charge Point are listening to the following topic to simulate interaction with a user resenting an RFID card : **cp_simu/cps/simu_cp_XXX/connectors/N/id_tag** where **N** stands for the connector number.
314315

315316
The expected command payload is :
316-
317+
317318
```
318319
{
319320
"id": "ID_TAG"

0 commit comments

Comments
 (0)