pimatic-luftdaten

Pimatic plugin for luftdaten sensors

Usage no npm install needed!

<script type="module">
  import pimaticLuftdaten from 'https://cdn.skypack.dev/pimatic-luftdaten';
</script>

README

pimatic-luftdaten

Pimatic plugin retrieves air quality sensor data from Luftdaten.info or a Luftdaten local sensor. Depending on the sensor the following information can be retrieved:

  • Particulate Matter (PM 10 and PM 2.5)
  • Temperature
  • Humidity
  • Pressure
  • Noise Level (average, max and min levels)

More info at luftdaten.info, where you can find instructions for building a luftdaten sensor (incl noise sensor) and how to get de Sensor ID or local IP address. The Air Quality Index (AQI) is calculated from pm10 and pm2.5 sensor data and is based on the U.S. EPA. The plugin supports also the Luftdaten noise sensor. In the gui a dBa classification (0-140 dBa) is added to the noise level data.

The plugin enables automatically attributes when data for an attribute is received. Sometimes a refresh of the gui is needed to see the values.

For the plugin no API key is required, it uses the open lufdaten.info API or the local sensor API.

Installation

To install the plugin add the plugin to the config.json of pimatic:

    {
      "plugin": "luftdaten"
    }

Device Configuration

There are 2 devices available

  • Luftdaten Device.

Gets air quality data from a specific sensor or area. The Air Quality Index (AQI) data is calculated from that. Add the device to the devices section:

    {
      "id": "luftdaten",
      "class": "LuftdatenDevice",
      "name": "Device for retrieving data from Luftdaten server",
      "sensorId": "Luftdaten sensor ID or local IP address of sensor",
      "latitude": latitude coordinate of the location you want info for,
      "longitude": longitude coordinate of the location you want info for,
      "radius": the radius of the cel for searching the closest sensor, default 1 km,
      "attributes": [
         "SENSOR_ID", "DISTANCE", "PM10", "PM25",
          "TEMP", "HUM", "BAR", "BAR_SEA",
          "WIFI", "NOISE_LEVEL", "NOISE_LEQ",
          "NOISE_LMIN", "NOISE_LMAX", "AQI",
          "AQI_CODE", "AQI_AIR_QUALITY"
        ] // this is the maximum set of attributes
      "minutes": 60, time between updates
    }

You need to configure a Luftdaten SensorId or a latitude/longitude/range combination. If you specify all, the SensorId will be used. If you use de lat/lon option, make sure the range is not to narrow (= no sensors). The maximum radius is 50 km. The device will automatically search for the closest sensors to get a complete data set. In the gui an attribute becomes visible when added in the device config.

  • Luftdaten Home Device.

Gets PM10, PM2.5, HUMidity, TEMPerature and BAR data from a local Luftdaten sensor. The Air Quality Index (AQI) data is calculated from that. The Luftdaten device is capable of handling all types of network (Luftdaten cloud and local IP sensor). The Luftdaten Home Device will therefore be removed from the plugin in one of the next versions.

Add the device with the local IP address into the devices section:

    {
      "id": "luftdaten",
      "class": "LuftdatenHomeDevice",
      "name": "Device for retrieving data from local sensor",
      "sensorIp": "local IP address of sensor",
      "minutes": 60, time between updates
    }

Usage

The following variables are available to you in Pimatic for the LuftdatenDevice (after selection in de config!).

  • ${luftdaten device id}.PM10 - Particals Matter 10 µg/m³
  • ${luftdaten device id}.PM25 - Particals Matter 2.5 µg/m³
  • ${luftdaten device id}.TEMP - Temperature in °C
  • ${luftdaten device id}.HUM - Humidity in %
  • ${luftdaten device id}.BAR - Pressure at the altitude of the sensor in hPa
  • ${luftdaten device id}.BAR_SEA - Pressure at sea level in hPa
  • ${luftdaten device id}.WIFI - Wifi signal strength in dBm
  • ${luftdaten device id}.NOISE_LEVEL - Current noise level classification
  • ${luftdaten device id}.NOISE_LEQ - Current noise level (average per 2.5 minutes) in dBa
  • ${luftdaten device id}.NOISE_LMIN - Lowest noise level in dBa
  • ${luftdaten device id}.NOISE_LMAX - Highest noise level in dBa
  • ${luftdaten device id}.AQI - index between 0 (very good) and 500 (very bad) air quality
  • ${luftdaten device id}.AQI_CODE - color code of air quality (green - purple)
  • ${luftdaten device id}.AQI_AIR_QUALITY - textual info on air quality level
  • ${luftdaten device id}.SENSOR_ID - Luftdaten ID of the sensor
  • ${luftdaten device id}.DISTANCE - Distance to the sensor (km)

The LuftdatenHome Device provides a subset of this data determined by the capabilities of the local sensor.

In the gui an attribute becomes visible when added in the device config.

The plugin is Node v10 compatible and in development. You could backup Pimatic before you are using this plugin!