Browse Source

Update README.md - specify format and commands

pull/1392/head
Knuti_in_Päse 1 year ago
committed by GitHub
parent
commit
279c9440f2
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 16
      tools/rpi/README.md

16
tools/rpi/README.md

@ -200,9 +200,9 @@ Configuration
Local settings are read from ahoy.yml Local settings are read from ahoy.yml
An example is provided as ahoy.yml.example An example is provided as ahoy.yml.example
If you have any problems with your radio module, If you have any problems with your radio module,
e.g.: cannot interpret received data, e.g.: cannot interpret received data,
please try to reduce the speed of your radio module! please try to reduce the speed of your radio module!
Add the following parameter to your `ahoy.yml` configuration file in section `nrf`: Add the following parameter to your `ahoy.yml` configuration file in section `nrf`:
`spispeed: 600000` (0.6 MHz) `spispeed: 600000` (0.6 MHz)
@ -214,15 +214,19 @@ The following command will run the communication tool, which will try to
contact the inverter every second on channel 40, and listen for replies. contact the inverter every second on channel 40, and listen for replies.
Whenever it sees a reply, it will decoded and logged to the given log file. Whenever it sees a reply, it will decoded and logged to the given log file.
```code
~~$ sudo python3 -um hoymiles --log-transactions --verbose --config /home/dtu/ahoy.yml | tee -a log2.log~~
## when using PYTHON virtual environment only - see hint `PEP 668`
$ source /home/pi/ahoyenv/bin/activate
~~$ sudo python3 -um hoymiles --log-transactions --verbose --config /home/dtu/ahoy.yml | tee -a log2.log
$ tail -f RPI-AHOY-DTU.log & $ tail -f RPI-AHOY-DTU.log &
$ python3 -um hoymiles --log-transactions --verbose --config /home/dtu/ahoy.yml $ python3 -um hoymiles --log-transactions --verbose --config /home/dtu/ahoy.yml
```
Python parameters Python parameters
- `-u` enables python's unbuffered mode - `-u` enables python's unbuffered mode
- `-m hoymiles` tells python to load module 'hoymiles' as main app - `-m hoymiles` tells python to load module 'hoymiles' as main app
Do not forget to stop `tail -f ...` Do not forget to stop `tail -f ...` with `fg`(forground) and than `ctrl-c`
The application describes itself The application describes itself
```code ```code
@ -301,7 +305,7 @@ A brief example log is supplied in the `example-logs` folder.
Todo Todo
---- ----
- Ability to talk to multiple inverters - Ability to talk to multiple inverters - implemented - please test
- MQTT gateway - MQTT gateway
- understand channel hopping - understand channel hopping
- ~~configurable polling interval~~ done: interval ist configurable in ahoy.yml - ~~configurable polling interval~~ done: interval ist configurable in ahoy.yml

Loading…
Cancel
Save