3pp-mirror/ahoy
1
0
Fork 0
mirror of https://github.com/lumapu/ahoy.git synced 2025-05-20 04:16:11 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #172 from chehrlic/chris_readme

Browse source 
Add comment about missing python modules, move section about ahoy
This commit is contained in:
lumapu 2022-08-18 22:02:47 +02:00 • committed by GitHub
commit ec1a88dcfd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

24
tools/rpi/README.md
View file

@ -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
----