1111[ ![ Discord] [ discord-shield ]] [ discord ]
1212[ ![ Community Forum] [ forum-shield ]] [ forum ]
1313
14- hassio support for Airthings Wave BLE environmental radon sensor .
14+ hassio support for Airthings Wave and Airthings Wave Plus BLE environmental radon sensors .
1515
1616![ ScreenShot] ( ScreenShot.png )
1717
18+ Much of the code to build this component was inspired by these projects:
19+ * http://airthings.com/raspberry-pi/
20+ * https://github.com/marcelm/radonwave
21+
22+ The aforementioned ` radonwave ` project is especially useful as it describes
23+ many of the BLE characteristics specific to this product and has good
24+ trouble-shooting tips. The script provided is also very useful in determining
25+ the MAC address of your AW device. See here:
26+ https://github.com/marcelm/radonwave/issues/3
27+
28+ ## Getting started
29+
30+ Download
31+ ```
32+ /custom_components/airthings_wave/
33+ ```
34+ into
35+ ```
36+ <config directory>/custom_components/airthings_wave/
37+ ```
1838** Example configuration.yaml:**
1939
2040``` yaml
2141# Example configuration.yaml entry
2242sensor :
2343 - platform : airthings_wave
24- mac : " 98:07:2D:4A:97:5C"
25- name : ' Basement Airthings Wave'
2644 scan_interval : 120
2745` ` `
2846### Configuration Variables
2947
3048**mac**
3149
32- (string)(Required) The airthings_wave mac address
33-
34- **name**
35-
36- (string)(Optional) The name of the device. Defaults to 'Airthings Wave'
50+ (string)(Optional) The airthings_wave mac address, if not provided will scan for all airthings devices at startup
3751
3852**scan_interval**
3953
4054 (string)(Optional) The interval between polls. Defaults to 300 seconds (5 minutes)
4155
56+
4257## Limitations
4358
4459It may be possible that the Wave must be connected to the official app at least
@@ -54,22 +69,16 @@ first.
5469
5570## Known Issues
5671
57- * Note yet compatible with Airthings Wave __Plus__
58-
59- * Values only appear after first scan_interval (default 5 minutes) has passed
60- and will remain as ` unknown` until then
61- https://github.com/custom-components/sensor.airthings_wave/issues/2
62-
6372* Not yet able to specify the ` monitored_conditions` configuration
6473
6574* No translations available yet
6675
6776
6877# # Hardware Requirements
6978
70- * An Airthings Wave
79+ * An Airthings Wave __OR__ Airthings Wave Plus
7180
72- * A Raspberry Pi 3 with built-in Bluetooth __OR__ a Bluetooth adapter that supports Bluetooth Low Energy (BLE). such as this
81+ * A Raspberry Pi 3/4 with built-in Bluetooth __OR__ a Bluetooth adapter that supports Bluetooth Low Energy (BLE). such as this
7382one : https://www.amazon.com/dp/B01N5MGEUS/ref=cm_sw_r_tw_dp_U_x_ObdNCb03P7QZJ
7483
7584# # Other Resources
0 commit comments