AirSense - Indoor Air Quality Sensor Board

This repository contains the pre-installed ESPHome config for the AirSense board. Specifications of the board can be found at https://loopon.tech/products/airsense

⚠️ Caution: Some electronic components are highly sensitive to Electrostatic Discharge and are damaged easily by this. Avoid direct contact with the LED and the ESP.

Table of Contents

• Getting Started
  • Connecting to WiFi
• Home Assistant
  • Discovery
  • View Device
  • Import Blueprint
  • Disabling Default LED and Buzzer Behaviour
  • RTTTL (Melody) Service
• Modifying ESPHome Config
  • Using ESPHome Dashboard in Home Assistant
  • Using ESPHome CLI
• Flashing the AirSense Board
• Arduino Example Projects
  • 1. Demo

Getting Started

The AirSense board comes pre-installed with ESPHome. The configuration can be found here.

Connecting to WiFi

There are two ways to connect the AirSense board to your WiFi network:

Using Imrpov

1. Power up the AirSense board.
2. Go to https://www.improv-wifi.com/ on your phone or a computer with Bluetooth.
3. Click "Connect device to Wi-Fi".
4. Select the AirSense device.

5. Input your SSID and password.
6. Click Save.

Using the Access Point

1. Power up the AirSense board.
2. On your phone or computer, search for the AirSense WiFi network.
3. Once connected, your phone will be redirected to the WiFi setup page. If you are not redirected, open a browser and go to http://192.168.4.1
4. Select your WiFi network SSID from the list and input the password if needed.
5. Click Save.

Home Assistant

Once you have successfully connected to your WiFi network, you can integrate the device to Home Assistant. You must have the ESPHome Add-on installed. If you do not have the Add-on then follow the 'Installing ESPHome Dashboard' guide here.

Discovery

Home Assistant and the ESPHome Add-on will automatically detect the AirSense device.

You can find the device in:

• Integrations:

• ESPHome Dashboard:

Note: If the device does not show up then please try restarting Home Assistant.

View Device

You can now view the AirSense board in

Import Blueprint

Use the Import Blueprint at the top of this page to define your own behaviour. The blueprint allows you to set the IAQ classifiers to trigger at. See the example below:

Disabling Default LED and Buzzer Behaviour

If you have imported the Home Assistant Blueprint or created your own rules, then you may want to turn off the following switches to disable the default behaviour of the RGB LED and the buzzer:

RTTTL (Melody) Service

The Ring Tone Text Transfer Language service will automatically be available in your Home Assistant with AirSense. You can invoke this service to play custom beeps and melodies. Click here for examples.

Modifying ESPHome Config

You can modify the way the device behaves by compiling and flashing the AirSense board.

Using ESPHome Dashboard in Home Assistant

1. Go to the ESPHome dashboard in Home Assistant.
2. Select the device you would like to modify and click "Edit".
3. Make your changes in the yaml and click "Install".
4. Select "Wirelessly" from the pop-up.
5. ESPHome will now compile the latest yaml and install it on the device. This will take a few minutes.

Using ESPHome CLI

1. Make sure ESPHome is installed on your computer (guide).
2. Clone this repo: git clone https://github.com/LoopOnCode/AirSense or download and extract the zip.
3. Make your changes to loopon_airsense.yaml.
4. Put the device into flash mode. See here.
5. Compile and flash: esphome run ./AirSense/esphome/loopon_airsense.yaml --no-logs
6. Reset the device.
7. (Optional) Monitor the logs: esphome logs ./AirSense/esphome/loopon_airsense.yaml

Flashing the AirSense Board

To flash the AirSense board, it must be put in the correct boot mode. You can do this by:

1. Connecting the device to a computer using a USB-C cable.
2. Holding down the boot button.
3. Momentarily pressing the reset button.
4. Then, releasing the boot button.

Once flashing has completed, press the reset button to restart in normal mode.

Arduino Example Projects

PlatformIO

PlatformIO is a cross-platform IDE extension for Visual Studio Code. Use PlatformIO to open, build and upload the example projects to the Unity board. The installation guide can be found here.

1. Demo

This demo project showcases:

1. how to gather data from the environment sensor
2. how to set the colour on the RGB LED
3. how to read the button state
4. how to produce a tone with the buzzer