Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

homebridge-airrohr

1.1.6 • Public • Published

homebridge-airrohr

Tavis CI build status

HomeBridge module for the DIY luftdaten.info air particulates sensor from OpenData Stuttgart.

It can be used to see the status of your own sensor in HomeKit. You can also use it to see another sensor if its data is published to api.luftdaten.info (see here).

Features

  • See air quality (incl. particulates values for PM10 and PM2.5), temperature and humidity in HomeKit and the Home app
  • Get the data from a sensor on your local network
  • Get the data from public sensor on api.luftdaten.info
  • Soon: See history for temperature, etc. using the Elgato Eve app

Setup

First follow the instructions for HomeBridge.

Install homebridge-airrohr using (sudo) npm install -g homebridge-airrohr.

Configure your AirRohr sensor in the homebridge settings file. See config.sample.json. All settings except update_interval_seconds (defaults to 120 seconds) and history (defaults to persisting to memory) are required.

See the documentation of the fakegato-history module for the list of supported options.

To run this project you have two options

Option A: The sensor & homebridge in your (home) network

To do this set json_data to

http://feinstaubsensor-<YOUR_SENSOR_ID>.local/data.json

using the same local network as your sensor.

Note: If you use a HomeKit hub (like a Apple TV or a iPad) you can still access your data from outside your home. See Apple's documentation for details.

Don't set public_temperature_json_data or public_airquality_json_data in this scenario.

Option B: Use the luftdaten.info API

This allows you to add any sensor not only your own. To get the same functionality as above you need to set two IDs/URLs:

  • Set public_temperature_json_data to the URL where to find the temperature data: http://api.luftdaten.info/v1/sensor/<YOUR_TEMPERATURE_SENSOR_ID>/

  • Set public_airquality_json_data to the URL where to find the air particulates (PM10, PM25) data: http://api.luftdaten.info/v1/sensor/<YOUR_AIRQUALITY_SENSOR_ID>/

Don't set json_data in this scenario.

Note: If you set json_data the public_… settings will be ignored.

Demo

homebridge-airrohr in apple home app

install

npm i homebridge-airrohr

Downloadsweekly downloads

12

version

1.1.6

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability