Support for battery and illuminance sensors for Airthings Wave+ devices.

Author: mjmccans

CHANGELOG.md

@@ -1,10 +1,16 @@
+## [1.0.0] - 2022-02-13
+### New
+* Support for battery and illuminance sensors for Airthings Wave+ devices pulled from upstream.
+
+
 ## [0.0.4] - 2022-02-04
 ### New
 * Add support for long-term statistics.
 
 ### Fixes
 * Updated logging format to show date and time.
 
+
 ## [0.0.3] - 2021-09-19
 ### Fixes
 * Fix issue with addon not restarting when bluetooth adapter is not available on system reboot.

config.yaml

@@ -1,5 +1,5 @@
 name: Airthings
-version: 0.0.4
+version: 1.0.0
 slug: airthings
 description: Read sensor values from Airthings Wave environmental monitoring devices
 url: https://github.com/mjmccans/hassio-addon-airthings

src/airthings-mqtt.ha.py

@@ -38,7 +38,9 @@
     "voc": {"name": "VOC", "device_class": None, "unit_of_measurement": "ppb", "icon": "mdi:cloud", "state_class": "measurement"},
     "temperature": {"name": "Temperature", "device_class": "temperature", "unit_of_measurement": "°C", "icon": None, "state_class": "measurement"},
     "humidity": {"name": "Humidity", "device_class": "humidity", "unit_of_measurement": "%", "icon": None, "state_class": "measurement"},
-    "rel_atm_pressure": {"name": "Pressure", "device_class": "pressure", "unit_of_measurement": "mbar", "icon": None, "state_class": "measurement"}
+    "rel_atm_pressure": {"name": "Pressure", "device_class": "pressure", "unit_of_measurement": "mbar", "icon": None, "state_class": "measurement"},
+    "illuminance": {"name": "Illuminance", "device_class": "illuminance", "unit_of_measurement": "lx", "icon": None, "state_class": "measurement"},
+    "battery": {"name": "Battery", "device_class": "battery", "unit_of_measurement": "%", "icon": None, "state_class": "measurement"}
 }
 
 class ATSensors:
@@ -288,8 +290,11 @@ def mqtt_publish(msgs):
                         # Consistent mac formatting
                         mac = mac.lower()
                         if isinstance(val, str) == False:
+                            # Edit or format sensor data as needed
                             if name == "temperature":
                                 val = round(val,1)
+                            elif name == "battery":
+                                val = max(0, min(100, round( (val-2.4)/(3.2-2.4)*100 ))) # Voltage is between 2.4 and 3.2
                             else:
                                 val = round(val)
                         _LOGGER.info("{} = {}".format("airthings/"+mac+"/"+name, val))

src/airthings.py

@@ -38,6 +38,7 @@
 _LOGGER = logging.getLogger(__name__)
 
 # Use full UUID since we do not use UUID from bluepy.btle
+CHAR_UUID_CCCD   = btle.UUID('2902') # Client Characteristic Configuration Descriptor (CCCD)
 CHAR_UUID_MANUFACTURER_NAME = UUID('00002a29-0000-1000-8000-00805f9b34fb')
 CHAR_UUID_SERIAL_NUMBER_STRING = UUID('00002a25-0000-1000-8000-00805f9b34fb')
 CHAR_UUID_MODEL_NUMBER_STRING = UUID('00002a24-0000-1000-8000-00805f9b34fb')
@@ -51,6 +52,7 @@
 CHAR_UUID_WAVE_PLUS_DATA = UUID('b42e2a68-ade7-11e4-89d3-123b93f75cba')
 CHAR_UUID_WAVE_2_DATA = UUID('b42e4dcc-ade7-11e4-89d3-123b93f75cba')
 CHAR_UUID_WAVEMINI_DATA = UUID('b42e3b98-ade7-11e4-89d3-123b93f75cba')
+COMMAND_UUID = UUID('b42e2d06-ade7-11e4-89d3-123b93f75cba') # "Access Control Point" Characteristic
 
 Characteristic = namedtuple('Characteristic', ['uuid', 'name', 'format'])
 
@@ -74,7 +76,8 @@ def __str__(self):
 
 sensors_characteristics_uuid = [CHAR_UUID_DATETIME, CHAR_UUID_TEMPERATURE, CHAR_UUID_HUMIDITY, CHAR_UUID_RADON_1DAYAVG,
                                 CHAR_UUID_RADON_LONG_TERM_AVG, CHAR_UUID_ILLUMINANCE_ACCELEROMETER,
-                                CHAR_UUID_WAVE_PLUS_DATA,CHAR_UUID_WAVE_2_DATA,CHAR_UUID_WAVEMINI_DATA]
+                                CHAR_UUID_WAVE_PLUS_DATA,CHAR_UUID_WAVE_2_DATA,CHAR_UUID_WAVEMINI_DATA,
+                                COMMAND_UUID]
 
 sensors_characteristics_uuid_str = [str(x) for x in sensors_characteristics_uuid]
 
@@ -153,6 +156,47 @@ def decode_data(self, raw_data):
         return data
 
 
+class CommandDecode:
+    def __init__(self, name, format_type, cmd):
+        self.name = name
+        self.format_type = format_type
+        self.cmd = cmd
+
+    def decode_data(self, raw_data):
+        if raw_data is None:
+            return {}
+        cmd = raw_data[0:1]
+        if cmd != self.cmd:
+            _LOGGER.warning("Result for Wrong command received, expected {} got {}".format(self.cmd.hex(), cmd.hex()))
+            return {}
+        
+        if len(raw_data[2:]) != struct.calcsize(self.format_type):
+            _LOGGER.debug("Wrong length data received ({}) verses expected ({})".format(len(cmd), struct.calcsize(self.format_type)))
+            return {}
+        val = struct.unpack(
+            self.format_type,
+            raw_data[2:])
+        res = {}
+        res['illuminance'] = val[2]
+        #res['measurement_periods'] =  val[5]
+        res['battery'] = val[17] / 1000.0
+
+        return res
+
+
+class MyDelegate(btle.DefaultDelegate):
+    def __init__(self):
+        btle.DefaultDelegate.__init__(self)
+        # ... initialise here
+        self.data = None
+
+    def handleNotification(self, cHandle, data):
+        if self.data is None:
+            self.data = data
+        else:
+            self.data = self.data + data
+
+
 sensor_decoders = {str(CHAR_UUID_WAVE_PLUS_DATA):WavePlussDecode(name="Pluss", format_type='BBBBHHHHHHHH', scale=0),
                    str(CHAR_UUID_DATETIME):WaveDecodeDate(name="date_time", format_type='HBBBBB', scale=0),
                    str(CHAR_UUID_HUMIDITY):BaseDecode(name="humidity", format_type='H', scale=1.0/100.0),
@@ -163,6 +207,8 @@ def decode_data(self, raw_data):
                    str(CHAR_UUID_WAVE_2_DATA):Wave2Decode(name="Wave2", format_type='<4B8H', scale=1.0),
                    str(CHAR_UUID_WAVEMINI_DATA):WaveMiniDecode(name="WaveMini", format_type='<HHHHHHLL', scale=1.0),}
 
+command_decoders = {str(COMMAND_UUID):CommandDecode(name="Battery", format_type='<L12B6H', cmd=struct.pack('<B', 0x6d))}
+
 
 class AirthingsWaveDetect:
     def __init__(self, scan_interval, mac=None):
@@ -184,7 +230,7 @@ def _parse_serial_number(self, manufacturer_data):
 
     def find_devices(self, scans=50, timeout=0.1):
         # Search for devices, scan for BLE devices scans times for timeout seconds
-        # Get manufacturer data and try to match match it to airthings ID.
+        # Get manufacturer data and try to match it to airthings ID.
         scanner = btle.Scanner()
         for _count in range(scans):
             advertisements = scanner.scan(timeout)
@@ -204,6 +250,8 @@ def connect(self, mac, retries=10):
             tries += 1
             try:
                 self._dev = btle.Peripheral(mac.lower())
+                self.delgate = MyDelegate()
+                self._dev.withDelegate( self.delgate )
                 break
             except Exception as e:
                 # print(e)
@@ -264,15 +312,34 @@ def get_sensor_data(self):
                 if self._dev is not None:
                     try:
                         for characteristic in characteristics:
+                            sensor_data = None
                             if str(characteristic.uuid) in sensor_decoders:
                                 char = self._dev.getCharacteristics(uuid=characteristic.uuid)[0]
                                 data = char.read()
                                 sensor_data = sensor_decoders[str(characteristic.uuid)].decode_data(data)
                                 _LOGGER.debug("{} Got sensordata {}".format(mac, sensor_data))
+                            
+                            if str(characteristic.uuid) in command_decoders:
+                                self.delgate.data = None # Clear the delegate so it is ready for new data.
+                                char = self._dev.getCharacteristics(uuid=characteristic.uuid)[0]
+                                # Do these steps to get notification to work, I do not know how it works, this link should explain it
+                                # https://devzone.nordicsemi.com/guides/short-range-guides/b/bluetooth-low-energy/posts/ble-characteristics-a-beginners-tutorial
+                                desc, = char.getDescriptors(forUUID=CHAR_UUID_CCCD)
+                                desc.write(struct.pack('<H', 1), True)
+                                char.write(command_decoders[str(characteristic.uuid)].cmd)
+                                for i in range(3):
+                                    if self._dev.waitForNotifications(0.1):
+                                        _LOGGER.debug("Received notification, total data received len {}".format(len(self.delgate.data)))
+                                
+                                sensor_data = command_decoders[str(characteristic.uuid)].decode_data(self.delgate.data)
+                                _LOGGER.debug("{} Got cmddata {}".format(mac, sensor_data))
+
+                            if sensor_data is not None:
                                 if self.sensordata.get(mac) is None:
                                     self.sensordata[mac] = sensor_data
                                 else:
                                     self.sensordata[mac].update(sensor_data)
+                                    
                     except btle.BTLEDisconnectError:
                         _LOGGER.exception("Disconnected")
                         self._dev = None