|
1 | 1 | # sensor.airthings_wave
|
2 |
| -[![GitHub Release][releases-shield]][releases] |
3 |
| -[![GitHub Activity][commits-shield]][commits] |
4 |
| -[![custom_updater][customupdaterbadge]][customupdater] |
5 |
| -[![License][license-shield]](LICENSE.md) |
6 | 2 |
|
7 |
| -![Project Maintenance][maintenance-shield] |
8 |
| -[![BuyMeCoffee][buymecoffeebadge]][buymecoffee] |
9 |
| -[![BuyMeCoffee][buymebeerbadge]][buymebeer] |
| 3 | +# Great news! This HACS component is now deprecated and retired and has been replaced by the official [Airthings BLE integration](https://www.home-assistant.io/integrations/airthings_ble/) |
10 | 4 |
|
11 |
| -[![Discord][discord-shield]][discord] |
12 |
| -[![Community Forum][forum-shield]][forum] |
| 5 | +Please remove this integration and use the official one in it's place |
13 | 6 |
|
14 |
| -hassio support for Airthings Wave, Airthings Wave Plus, and Airthings Wave Mini BLE environmental sensors. |
| 7 | +A big thank you to everyone who have helped support this integration, and a thank you to @vincegio for porting it into the official Home Assistant repository. |
15 | 8 |
|
16 |
| -This component is cloudless and accomplishes this by communicating over bluetooth instead of using Airthings' cloud API. |
| 9 | +*** |
17 | 10 |
|
18 |
| - |
19 |
| - |
20 |
| -Much of the code to build this component was inspired by these projects: |
21 |
| -* http://airthings.com/raspberry-pi/ |
22 |
| -* https://github.com/marcelm/radonwave |
23 |
| - |
24 |
| -The aforementioned `radonwave` project is especially useful as it describes |
25 |
| -many of the BLE characteristics specific to this product and has good |
26 |
| -trouble-shooting tips. The script provided is also very useful in determining |
27 |
| -the MAC address of your AW device. See here: |
28 |
| -https://github.com/marcelm/radonwave/issues/3 |
29 |
| - |
30 |
| -## Getting started |
31 |
| - |
32 |
| -Download |
33 |
| -``` |
34 |
| -/custom_components/airthings_wave/ |
35 |
| -``` |
36 |
| -into |
37 |
| -``` |
38 |
| -<config directory>/custom_components/airthings_wave/ |
39 |
| -``` |
40 |
| -**Example configuration.yaml:** |
41 |
| - |
42 |
| -```yaml |
43 |
| -# Example configuration.yaml entry |
44 |
| -sensor: |
45 |
| - - platform: airthings_wave |
46 |
| - scan_interval: 120 |
47 |
| -``` |
48 |
| -### Optional Configuration Variables |
49 |
| -
|
50 |
| -**mac** |
51 |
| -
|
52 |
| - (string)(Optional) The airthings_wave mac address, if not provided will scan for all airthings devices at startup |
53 |
| -
|
54 |
| -**scan_interval** |
55 |
| -
|
56 |
| - (string)(Optional) The interval between polls. Defaults to 300 seconds (5 minutes) |
57 |
| -
|
58 |
| -
|
59 |
| -## Limitations |
60 |
| -
|
61 |
| -It may be possible that the Wave must be connected to the official app at least |
62 |
| -once before you can use this program, so you will probably not get around |
63 |
| -registering an account with Airthings. |
64 |
| -
|
65 |
| -The radon level history stored on the Wave itself cannot be accessed |
66 |
| -with this component. To get around this, it connects regularly to the radon |
67 |
| -detector. |
68 |
| -
|
69 |
| -Make sure you install the latest firmware on the device using the official app |
70 |
| -first. |
71 |
| -
|
72 |
| -## Known Issues |
73 |
| -
|
74 |
| -* Not yet able to specify the `monitored_conditions` configuration |
75 |
| - |
76 |
| -* No translations available yet |
77 |
| - |
78 |
| - |
79 |
| -## Hardware Requirements |
80 |
| - |
81 |
| -* An Airthings Wave __OR__ Airthings Wave Plus __OR__ Airthings Wave Mini |
82 |
| - |
83 |
| -* A Raspberry Pi 3/4 with built-in Bluetooth __OR__ a Bluetooth adapter that supports Bluetooth Low Energy (BLE). such as this |
84 |
| -one: https://www.amazon.com/dp/B01N5MGEUS/ref=cm_sw_r_tw_dp_U_x_ObdNCb03P7QZJ |
85 |
| - |
86 |
| -## Other Resources |
87 |
| -* https://github.com/marcelm/radonwave/issues/1 |
88 |
| -* https://community.home-assistant.io/t/radoneye-ble-interface/94962 |
89 |
| -* https://support.airthings.com/hc/en-us/articles/115002910089-How-to-respond-to-your-radon-levels?mobile_site=true |
90 |
| -* https://community.home-assistant.io/t/converting-sensor-measurement-units/98807 |
91 |
| -* http://certi.us/Downloads/Canada_Meas_BW.pdf |
92 |
| - |
93 |
| -[airthings_wave]: https://github.com/custom-components/sensor.airthings_wave |
94 |
| -[buymecoffee]: https://buymeacoff.ee/MartyTremblay |
95 |
| -[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge |
96 |
| -[buymebeer]: https://paypal.me/MartyTremblay |
97 |
| -[buymebeerbadge]: https://img.shields.io/badge/buy%20me%20a%20beer-donate-yellow.svg?style=for-the-badge |
98 |
| -[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-components/sensor.airthings_wave.svg?style=for-the-badge |
99 |
| -[commits]: https://github.com/custom-components/sensor.airthings_wave/commits/master |
100 |
| -[customupdater]: https://github.com/custom-components/custom_updater |
101 |
| -[customupdaterbadge]: https://img.shields.io/badge/custom__updater-true-success.svg?style=for-the-badge |
102 |
| -[discord]: https://discord.gg/Qa5fW2R |
103 |
| -[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge |
104 |
| -[exampleimg]: example.png |
105 |
| -[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge |
106 |
| -[forum]: https://community.home-assistant.io/ |
107 |
| -[license-shield]: https://img.shields.io/github/license/custom-components/sensor.airthings_wave.svg?style=for-the-badge |
108 |
| -[maintenance-shield]: https://img.shields.io/badge/maintainer-MartyTremblay-blue.svg?style=for-the-badge |
109 |
| -[releases-shield]: https://img.shields.io/github/release/custom-components/sensor.airthings_wave.svg?style=for-the-badge |
110 |
| -[releases]: https://github.com/custom-components/sensor.airthings_wave/releases |
0 commit comments