From 5f6b175742899f0c1a14d51e12a853cdbf7d94fc Mon Sep 17 00:00:00 2001 From: Christian Ehrlicher <ch.ehrlicher@gmx.de> Date: Wed, 17 Aug 2022 20:06:57 +0200 Subject: [PATCH] Add comment about missing python modules, move section about ahoy example config before the 'example run' section. --- tools/rpi/README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/tools/rpi/README.md b/tools/rpi/README.md index f779b8b8..1027ccb0 100644 --- a/tools/rpi/README.md +++ b/tools/rpi/README.md @@ -80,6 +80,21 @@ python3 getting_started.py # to test and see whether RF24 class can be loaded as If there are no error messages on the last step, then the NRF24 Wrapper has been installed successfully. +Required python modules +----------------------- + +Some modules are not installed by default on a RaspberryPi, therefore add them manually: + +``` +pip install crcmod pyyaml paho-mqtt +``` + +Configuration +------------- + +Local settings are read from ahoy.yml +An example is provided as ahoy.yml.example + Example Run ----------- @@ -98,7 +113,7 @@ Python parameters The application describes itself ``` -python -m hoymiles --help +python3 -m hoymiles --help usage: hoymiles [-h] -c [CONFIG_FILE] [--log-transactions] [--verbose] Ahoy - Hoymiles solar inverter gateway @@ -158,13 +173,6 @@ A brief example log is supplied in the `example-logs` folder. -Configuration -------------- - -Local settings are read from ahoy.yml -An example is provided as ahoy.yml.example - - Todo ----