Merge branch 'master' of github.com:EtoTen/radonreader

README.md

@@ -1,5 +1,6 @@
 # RadonReader 2022 RD200 v2 (=>2022)
 
+This project provides a tool which allows users collect current radon data from FTLab Radon Eye RD200 v1 and V2 (2022+) (Bluetooth only versions). 
 
 EtoTen v0.4 - 07/05/2022
 - Forked Project
@@ -10,7 +11,6 @@ EtoTen v0.4 - 07/05/2022
 
 Note: if specifying an (-a) MAC address, you now also have to specify a device type (-t) (either 0 for original RD200 or 1 for RD200 v2)
 
-
 # Pre-req install steps:
 
 <pre><code>sudo apt install libglib2.0-dev
@@ -20,13 +20,29 @@ sudo setcap cap_net_raw+e /home/pi/.local/lib/python3.7/site-packages/bluepy/blu
 sudo setcap cap_net_admin+eip /home/pi/.local/lib/python3.7/site-packages/bluepy/bluepy-helper
 </pre></code>
 
+# Home assistant integration via MQTT:
+
+- Install mosquitto MQTT add-on in HA, configure it with a local user and password
+- Install mosquitto MQTT integration in HA
+- On the host machine run: <pre><code>python3 radon_reader.py -v -ms localhost -mu radonuser -mw radon123  -ma -m</pre></code>  and listen to:
+ "environment/RADONEYE/#" in the MQTT integration in HA to verify messages are being sent
+
+- Now make the app send automatic updates to HA every 3 minutes
+ <pre><code>crontab -e</pre></code> 
+ <pre><code>*/3 * * * * /usr/bin/python3 /home/pi/radonreader/radon_reader.py -v -a 94:3c:c6:dd:42:ce -t 1 -ms localhost -mu radonuser -mw radon123  -mw radon123  -ma -m #update radon reading via MQTT every 3 minutes</pre></code> 
+
+- Add this to configuration.yaml:
+<pre><code>
+mqtt:
+  sensor:
+    - state_topic: "environment/RADONEYE/#"
+      name: 'Radon Level'
+      unit_of_measurement: 'pCi/L'
+      value_template: "{{ value_json.radonvalue }}"
+</pre></code>
 
-
-------------
-
-This project provides a tool which allows users collect current radon data from FTLab Radon Eye RD200 (Bluetooth only version).
-
-
+- Now you cam add a sensor card to your HA view
+- 
 # Hardware Requirements
 - FTLabs RadonEye RD200 v1 or v2
 - Raspberry Pi w/Bluetooth LE (Low Energy) support (RPi 3B/4/etc...)
@@ -37,10 +53,9 @@ This project provides a tool which allows users collect current radon data from
 - paho-mqtt Python library
 
 # History
-- 0.4 - Forked
+- 0.4 - Forked and modified extensively 
 - 0.3 - Added MQTT support
 
-
 # Usage
 <pre><code>usage: radon_reader.py [-h] [-a] ADDRESS [-t] DEVICE_TYPE [-b] [-v] [-s] [-m] [-ms MQTT_SRV]
                        [-mp MQTT_PORT] [-mu MQTT_USER] [-mw MQTT_PW] [-ma]