Explorar el Código

Update README.md

Thomas Dietrich hace 8 años
padre
commit
b8042ba98a
Se han modificado 1 ficheros con 11 adiciones y 16 borrados
  1. 11 16
      README.md

+ 11 - 16
README.md

@@ -1,12 +1,12 @@
 # Xiaomi Mi Flora Plant Sensor MQTT Client/Daemon
 
 A simple Linux python script to query arbitrary Mi Flora plant sensor devices and send the data to an **MQTT** server,
-e.g., the famous [Eclipse Mosquitto](https://projects.eclipse.org/projects/technology.mosquitto) or the embedded MQTT broker in [Home Assistant](https://home-assistant.io).
-
-The program can be executed in **daemon mode** to run continuously in the background.
+e.g., the famous [Eclipse Mosquitto](https://projects.eclipse.org/projects/technology.mosquitto) or the embedded MQTT broker in [Home Assistant](https://home-assistant.io). After data made the hop to the MQTT broker it can be used by home automation software like Home Assistant or [openHAB](https://openhab.org).
 
 ![Demo gif for command line execution](demo.gif)
 
+The program can be executed in **daemon mode** to run continuously in the background.
+
 ### Features
 
 * Support for [Xiaomi Mi Flora sensors](https://www.aliexpress.com/item/Newest-Original-Xiaomi-Flora-Monitor-Digital-Plants-Flowers-Soil-Water-Light-Tester-Sensor-Monitor-for-Aquarium/32685750372.html) (tested with firmware v2.6.2, v2.6.4, v2.6.6)
@@ -43,19 +43,18 @@ python3 mqtt-flora.py
 ```
 
 With a correct configuration the result should look similar to the the screencap above.
-
 The extensive output can be reduced to error messages:
 
 ```shell
 python3 mqtt-flora.py > /dev/null
 ```
- 
+
 You probably want to execute the program **continuously in the background**.
 This can either be done by using the internal daemon or cron.
 
-1. Detach from Shell
-   
-   Send the daemon into the background with some simple command line foo:
+**Attention:** Daemon mode can be enabled (default) and disabled in the config file.
+
+1. Send the program into the background with some simple command line foo:
    
    ```shell
    python3 /path/to/mqtt-flora.py &
@@ -63,20 +62,16 @@ This can either be done by using the internal daemon or cron.
    
    *Hint:* Bring back to foreground with `fg`.
 
-2. Screen Shell
-   
-   Send the daemon into the background inside a [screen shell](https://www.howtoforge.com/linux_screen):
+2. Screen Shell - Run the program inside a [screen shell](https://www.howtoforge.com/linux_screen):
    
    ```shell
    screen -S mqtt-flora -d -m python3 /path/to/mqtt-flora.py
    ```
 
-3. Cron job
-   
-   Add a new con job to e.g. `/etc/cron.d/miflora` to execute every 5 minutes
+3. Cron job - Add a new con job, e.g., `/etc/cron.d/miflora`, execute every 5 minutes
    
    ```shell
-   */5 * * * * python3 /path/to/mqtt-flora.py > /dev/null
+   */5 * * * * root python3 /path/to/mqtt-flora.py > /dev/null
    ```
 
 ### Integration
@@ -88,7 +83,7 @@ An example:
 {"light": 24, "moisture": 30, "temperature": 21.4, "conductivity": 1020, "battery": 100}
 ```
 
-This data can be subscribed to and processed by other applications, like Home Assistant or openHAB.
+This data can be subscribed to and processed by other applications, like [Home Assistant](https://home-assistant.io) or [openHAB](https://openhab.org).
 
 Enjoy!