Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add airthings wave plus docs #1081

Merged
merged 4 commits into from
Aug 31, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
73 changes: 73 additions & 0 deletions components/sensor/airthings_ble.rst
@@ -0,0 +1,73 @@
AirThings BLE Sensors
========================

.. seo::
:description: Instructions for setting up AirThings bluetooth-based sensors in ESPHome.
:keywords: AirThings, BLE, Bluetooth, Wave Plus

The ``airthings_wave_plus`` sensor platform lets you track the output of AirThings Bluetooth Low Energy devices.

This component will track radon, airborne chemicals, CO2, temperature and humidity and others depending on the device sensors.

Device Discovery
-----------------

AirThings devices can be found using the ``airthings_ble`` ble scanner.

To find out your device's MAC address, add the following to your ESPHome configuration:

.. code-block:: yaml

logger:
level: DEBUG # Required for the tracker to show the device

esp32_ble_tracker:
airthings_ble:

The device will then listen for nearby devices, and display a message like this one:

``
[D][airthings_ble:019]:
Found AirThings device Serial: 123456789 (MAC: 01:02:03:04:05:06)
``

Once the device is found, **remove the ``airthings_ble:`` device tracker** from your configuration and take note of the device MAC address, and use it when configuring a sensor below.

Supported Devices
-----------------

Wave Plus
*********

AirThings Wave Plus tracks radon (24h and long term), airborne chemicals, CO2, temperature, atmospheric pressure and humidity.

.. figure:: images/airthings_wave_plus.jpg
:align: center
:width: 60.0%

Configuration example:

.. code-block:: yaml

sensor:
- platform: airthings_wave_plus
mac_address: '01:02:03:04:05:06'
update_interval: 5min # default
jeromelaban marked this conversation as resolved.
Show resolved Hide resolved
temperature:
name: "WavePlus Temperature"
radon:
name: "WavePlus Radon"
radon_long_term:
name: "WavePlus Radon Long Term"
pressure:
name: "WavePlus Pressure"
humidity:
name: "WavePlus Humidity"
co2:
name: "WavePlus CO2"
tvoc:
name: "WavePlus VOC"

.. note::

The sensor uses active polling of devices every 5 minutes as per the device reported internal refresh timeout.
Binary file added components/sensor/images/airthings_wave_plus.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/airthings_logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Expand Up @@ -97,6 +97,7 @@ Sensor Components
ADE7953, components/sensor/ade7953, ade7953.svg
ADS1115, components/sensor/ads1115, ads1115.jpg
AHT10, components/sensor/aht10, aht10.jpg
AirThings BLE, components/sensor/airthings_ble, airthings_logo.png
AM2320, components/sensor/am2320, am2320.jpg
APDS9960, components/sensor/apds9960, apds9960.jpg
ATM90E32, components/sensor/atm90e32, atm90e32.jpg
Expand Down