Git Product home page Git Product logo

homebridge-purpleair's Introduction

Homebridge PurpleAir Plugin

verified-by-homebridge github npm

A Homebridge plugin to connect PurpleAir sensors.

  • Exposes humidity, temperature and VOC readings
  • Supports updated US EPA PM2.5 AQI conversion
  • Increased accuracy with Dual Laser readings
  • Can report AQI instead of PM2.5 Density
  • Detects sensor firmware and model
  • Works with multiple and private sensors

This plugin only supports local sensors, if you want to use PurpleAir's paid API use Jacek Suliga's excellent Homebridge PurpleAir Sensor plugin.

Installation

Search for homebridge-purpleair in Homebridge UI, or install it via CLI:

$ sudo npm install -g --unsafe-perm homebridge-purpleair

Configuration

You may configure this plugin using Homebridge UI, or by editing your config.json:

{
    "bridge": {},
    "accessories": [],
    "platforms": [
        {
            "platform": "PurpleAir",
            "conversion": "US_EPA",
            "aqiInsteadOfDensity": true,
            "sensors": [
                { "ip": "192.168.0.42" },
                { "ip": "192.168.0.47", "name": "PurpleAir Garage" }
            ]
        }
    ]
}
Option Type Default Description
conversion string US_EPA The data correction used to determine the air quality index (AQI).
aqiInsteadOfDensity boolean false (Optional) HomeKit doesn't expose the air quality index (AQI). If enabled, the plugin will report the AQI in the "PM2.5 Density (µg/m³)" field.
sensors array [] An array containing the PurpleAir sensors.
sensors[].ip string The IP address of the sensor on the local network.
sensors[].name string (Optional) The name of the sensor. Useful to distinguish multiple sensors.

Conversions

US EPA

Courtesy of the United States Environmental Protection Agency Office of Research and Development, correction equation from their US wide study (updated version from October 22 2021) as applied on the AirNow Fire and Smoke Map.

homebridge-purpleair's People

Contributors

tillkruss avatar

Watchers

 avatar

homebridge-purpleair's Issues

AQI tile?

Can we make the sensors a tile in HomeKit?

Adjustable temperature and humidity correction?

Is your feature request related to a problem? Please describe:
The temperature and humidity from PurpleAir aren’t meant to represent ambient conditions, as they describe here in “A Note on Temperature and Humidity” https://community.purpleair.com/t/purpleair-sensors-functional-overview/150

Describe the solution you'd like:
Given that PurpleAir applies both a temperature and humidity correction when this is viewed on the map, it would be helpful to similarly allow a correction to be applied to the temperature and humidity numbers reported to HomeKit through this module.

PurpleAir defaults to adjusting by -8°F and 4% humidity. That seems like a solid default, though it would be nice for the offsets to be adjustable as an advanced option, if users can measure that a different offset is more accurate for their sensor(s).

see attached screenshots for my PurpleAir sensor readings in two rooms compare to the HomePod mini and Eve / Qingping temperature/ humidity sensors next to them in those spaces.
IMG_4526
IMG_4527

Thanks for making this plugin - it’s great to have!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.