├── __init__.py
├── manifest.json
├── README.md
├── sensor.py
└── LICENSE


/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | 	"domain": "airthings",
3 | 	"name": "Airthings Wave+",
4 | 	"documentation": "https://github.com/gkreitz/homeassistant-airthings",
5 | 	"dependencies": [],
6 | 	"requirements": ["pygatt[GATTTOOL]==4.0.3"],
7 | 	"codeowners": ["@gkreitz"]
8 | }
9 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # homeassistant-airthings
 2 | Quick n' dirty hack to get Airthings Wave Plus sensor into Home Assistant. Beware, very untested. Only works with Airthings Wave Plus.
 3 | 
 4 | I wanted something to read my Airthings Wave Plus, so I built this. Far from production quality. Magic hardcoded constants. Reads data the wrong way to work around a bug. Tested on a single device. Only supports a single Wave Plus. Does not construct a unique id for the sensor. Figured I may as well upload in case it's useful to someone else.
 5 | 
 6 | ## Installation
 7 | 1. Find out the MAC address of your Airthings Wave Plus. See https://airthings.com/us/raspberry-pi/ for how to find MAC address.
 8 | 1. Put `__init__.py`, `sensor.py`, `manifest.json` into `<config>/custom_components/airthings/` on your home assistant installation (where `<config>` is the directory where your config file resides).
 9 | 1. Add the following to your `configuration.yaml` (or modify your `sensor` heading, if you already have one):
10 | ```yaml
11 | sensor:
12 |   - platform: airthings
13 |     mac: 00:11:22:AA:BB:CC # replace with MAC of your Airthings Wave+
14 | ```
15 | 
16 | Then restart home assistant and if everything works, you'll have some new sensors named `sensor.airthings_{co2,humidity,longterm_radon,pressure,shortterm_radon,temperature,voc}`
17 | 


--------------------------------------------------------------------------------
/sensor.py:
--------------------------------------------------------------------------------
  1 | import logging
  2 | import struct
  3 | import datetime
  4 | 
  5 | from homeassistant.components.sensor import PLATFORM_SCHEMA
  6 | import homeassistant.helpers.config_validation as cv
  7 | import voluptuous as vol
  8 | 
  9 | from homeassistant.helpers.entity import Entity
 10 | from homeassistant.util import Throttle
 11 | from homeassistant.const import (TEMP_CELSIUS, DEVICE_CLASS_HUMIDITY, DEVICE_CLASS_TEMPERATURE, DEVICE_CLASS_PRESSURE, STATE_UNKNOWN)
 12 | 
 13 | _LOGGER = logging.getLogger(__name__)
 14 | 
 15 | DOMAIN = 'airthings'
 16 | CONF_MAC = 'mac'
 17 | 
 18 | PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
 19 |     vol.Required(CONF_MAC): cv.string,
 20 | })
 21 | 
 22 | MIN_TIME_BETWEEN_UPDATES = datetime.timedelta(minutes=15)
 23 | SENSOR_TYPES = [
 24 |     ['temperature', 'Temperature', TEMP_CELSIUS, None, DEVICE_CLASS_TEMPERATURE],
 25 |     ['co2', 'CO2', 'ppm', 'mdi:cloud', None],
 26 |     ['pressure', 'Pressure', 'mbar', 'mdi:gauge', DEVICE_CLASS_PRESSURE],
 27 |     ['humidity', 'Humidity', '%', None, DEVICE_CLASS_HUMIDITY],
 28 |     ['voc', 'VOC', 'ppm', 'mdi:cloud', None],
 29 |     ['short_radon', 'Short-term Radon', 'Bq/m3', 'mdi:cloud', None],
 30 |     ['long_radon', 'Long-term Radon', 'Bq/m3', 'mdi:cloud', None],
 31 | ]
 32 | 
 33 | 
 34 | 
 35 | def setup_platform(hass, config, add_devices, discovery_info=None):
 36 |     """Setup the sensor platform."""
 37 |     _LOGGER.debug("Starting airthings")
 38 |     reader = AirthingsWavePlusDataReader(config.get(CONF_MAC))
 39 |     add_devices([ AirthingsSensorEntity(reader, key,name,unit,icon,device_class) for [key, name, unit, icon, device_class] in SENSOR_TYPES])
 40 | 
 41 | class AirthingsWavePlusDataReader:
 42 |     def __init__(self, mac):
 43 |         self._mac = mac
 44 |         self._state = { }
 45 | 
 46 |     def get_data(self, key):
 47 |         if key in self._state:
 48 |             return self._state[key]
 49 |         return STATE_UNKNOWN
 50 | 
 51 |     @property
 52 |     def mac(self):
 53 |         return self._mac
 54 | 
 55 |     @Throttle(MIN_TIME_BETWEEN_UPDATES)
 56 |     def update(self):
 57 |         _LOGGER.debug("Airthings updating data")
 58 |         import pygatt
 59 |         from pygatt.backends import Characteristic
 60 |         adapter = pygatt.backends.GATTToolBackend()
 61 |         char = 'b42e2a68-ade7-11e4-89d3-123b93f75cba'
 62 |         try:
 63 |             # reset_on_start must be false - reset is hardcoded to do sudo, which does not exist in the hass.io Docker container.
 64 |             adapter.start(reset_on_start=False)
 65 |             device = adapter.connect(self._mac)
 66 |             # Unclear why this does not work. Seems broken in the command line tool too. Hopefully handle is stable...
 67 |             #value = device.char_read(char,timeout=10)
 68 |             value = device.char_read_handle('0x000d',timeout=10)
 69 |             (humidity, light, sh_rad, lo_rad, temp, pressure, co2, voc) = struct.unpack('<xbxbHHHHHHxxxx', value)
 70 |             self._state['humidity'] = humidity / 2.0
 71 |             self._state['light'] = light * 1.0
 72 |             self._state['short_radon'] = sh_rad
 73 |             self._state['long_radon'] = lo_rad
 74 |             self._state['temperature'] = temp / 100.
 75 |             self._state['pressure'] = pressure / 50.
 76 |             self._state['co2'] = co2 * 1.
 77 |             self._state['voc'] = voc * 1.
 78 |         finally:
 79 |             adapter.stop()
 80 | 
 81 | class AirthingsSensorEntity(Entity):
 82 |     """Representation of a Sensor."""
 83 | 
 84 |     def __init__(self, reader, key, name, unit, icon, device_class):
 85 |         """Initialize the sensor."""
 86 |         self._reader = reader
 87 |         self._key = key
 88 |         self._name = name
 89 |         self._unit = unit
 90 |         self._icon = icon
 91 |         self._device_class = device_class
 92 | 
 93 |     @property
 94 |     def name(self):
 95 |         """Return the name of the sensor."""
 96 |         return 'Airthings {}'.format(self._name)
 97 | 
 98 |     @property
 99 |     def icon(self):
100 |         """Return the icon of the sensor."""
101 |         return self._icon
102 | 
103 |     @property
104 |     def device_class(self):
105 |         """Return the icon of the sensor."""
106 |         return self._device_class
107 | 
108 |     @property
109 |     def state(self):
110 |         """Return the state of the sensor."""
111 |         return self._reader.get_data(self._key)
112 | 
113 |     @property
114 |     def unit_of_measurement(self):
115 |         """Return the unit of measurement."""
116 |         return self._unit
117 | 
118 |     @property
119 |     def unique_id(self):
120 |         return '{}-{}'.format(self._reader.mac, self._name)
121 | 
122 |     def update(self):
123 |         """Fetch new state data for the sensor.
124 | 
125 |         This is the only method that should fetch new data for Home Assistant.
126 |         """
127 |         self._reader.update()
128 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------