English
English
简体中文
日本語
pdf-icon

Air Quality V1.1 Kit Home Assistant Integration

This chapter introduces the method for integrating the Air Quality v1.1 air quality monitoring device into Home Assistant.

Preparation

Quick Start

Click the button below to flash the firmware with one click. Follow the on-screen instructions to complete the configuration and quickly experience the Air Quality V1.1 Kit integration with Home Assistant. For one-click flashing and subsequent configuration, please refer to the tutorial.

Note

  • In this tutorial, the kit is compiled and uploaded under ESPHome 2025.10.3. If you encounter compilation/upload issues, consider switching ESPHome to this version.

Create Device

  1. Open ESPHome Builder, click NEW DEVICE in the bottom right corner to create a new device.

  2. Click CONTINUE in the pop-up.

  3. Select New Device Setup to create a new configuration file.

  4. Fill in the configuration file name.

  5. Select the device type. First, uncheck Use recommended settings, then click ESP32-S3.

  6. Select M5Stack StampS3.

  7. Copy the API Key for backup and click SKIP to skip.

Modify Configuration

  1. Click EDIT under the generated configuration file card to edit:

  2. Add the following at the end of the file:

    yaml
    1 2 3 4 5 6
    packages:
      air_quality_base_config:
        url: https://github.com/m5stack/esphome-yaml
        files: common/air-quality-v1-rev1-base.yaml
        ref: main
        refresh: 1d
  3. Click SAVE, INSTALL in the top right corner, and select Manual download from the pop-up installation methods.

    Note:
    The first compilation may take a long time. The compilation time depends on the performance of the Home Assistant host and the network quality.
  4. After compilation, click the Download button and select Factory Format to download the firmware.

Download and Flash Firmware

  1. Download firmware: Download the Factory Format firmware via the Manual download method in ESPHome Builder.

  2. Flash firmware using web tools:

    • Connect the kit to the host via a USB-C cable, open ESPHome Web, and click CONNECT to connect the device.

      Note
      If the device is not displayed, please refer to the Learn section to enter download mode.
    • Click INSTALL and select the previously compiled firmware to upload.

    • Click INSTALL again to flash and wait for the process to complete.

Getting Started

  1. After flashing the firmware, the device will automatically connect to Wi-Fi upon startup. The Home Assistant service will automatically discover the new device. Select the new device in Notifications, click Check it out -> CONFIGURE, and follow the pop-up steps to add the device to the specified area.

  2. If you do not receive a notification for the new device, you can also navigate to Settings -> Device & services to check the device status. Click Add to add the device to Home Assistant.

  3. Dashboard Example:

  4. Press the USER_A/USER_B buttons to switch pages and display more information.

    Note
    1. The time on the E-Ink display is sourced from Home Assistant and will automatically synchronize upon connection.
    2. Sensor data requires some time for sampling before being output to the display (at least 1 minute). Since enabling Wi-Fi for continuous operation increases power consumption and drains the battery quickly, it is recommended to connect a power source for more stable readings.

Video

On This Page