Process data from live API of luftdaten.info. Filter by station- and sensor-id, apply reverse geocoding, output as JSON, store into RDBMS databases and publish to MQTT.
Project description
Luftdatenpumpe
About
Luftdatenpumpe acquires the measurement readings either from the livedata API of luftdaten.info or from its archived CSV files published to archive.luftdaten.info.
While iterating the readings, it optionally applies a filter based on station-id, sensor-id or sensor-type and collects information about all stations and sensors they are originating from.
Then, each station’s location information gets enhanced by
attaching its geospatial position as a Geohash.
attaching a synthetic real-world address resolved using the reverse geocoding service Nominatim by OpenStreetMap.
Information about stations can be
displayed on STDOUT or STDERR in JSON format.
filtered and transformed interactively through jq, the swiss army knife of JSON manipulation.
stored into RDBMS databases like PostgreSQL using the fine dataset package. Being built on top of SQLAlchemy, this supports all major databases.
Measurement readings can be
Screenshot
Display luftdaten.info (LDI) measurements on Grafana Worldmap Panel.
Map and table display. Filter by synthesized address components and sensor type.
Long name from OSM address and station id on overlay.
Demo
Live Data
List of stations
Synopsis
Overview
# List stations luftdatenpumpe stations --station=28,297 --reverse-geocode # Write list of stations and metadata to PostgreSQL database luftdatenpumpe stations --station=28,1071 --reverse-geocode --target=postgresql:///luftdaten_meta # Forward readings to MQTT luftdatenpumpe readings --station=28,1071 --target=mqtt://mqtt.example.org/luftdaten.info
Details
$ luftdatenpumpe --help Usage: luftdatenpumpe stations [options] [--target=<target>]... luftdatenpumpe readings [options] [--target=<target>]... luftdatenpumpe --version luftdatenpumpe (-h | --help) Options: --source=<source> Data source, either "api" or "file://" [default: api]. --station=<stations> Filter data by given location ids, comma-separated. --sensor=<sensors> Filter data by given sensor ids, comma-separated. --reverse-geocode Compute geographical address using the Nominatim reverse geocoder --target=<target> Data output target --progress Show progress bar --version Show version information --dry-run Skip publishing to MQTT bus --disable-nominatim-cache Disable Nominatim reverse geocoder cache --debug Enable debug messages -h --help Show this screen Station list examples: # Display metadata for given stations in JSON format luftdatenpumpe stations --station=28,1071 --reverse-geocode # Display metadata for given sensors in JSON format luftdatenpumpe stations --sensor=657,2130 --reverse-geocode # Display list of stations in JSON format made of value/text items, suitable for use as a Grafana JSON data source luftdatenpumpe stations --station=28,1071 --reverse-geocode --target=json.grafana.vt+stream://sys.stdout # Display list of stations in JSON format made of key/name items, suitable for use as a mapping in Grafana Worldmap Panel luftdatenpumpe stations --station=28,1071 --reverse-geocode --target=json.grafana.kn+stream://sys.stdout # Write list of stations and metadata to RDBMS database (PostgreSQL), also display on STDERR luftdatenpumpe stations --station=28,1071 --reverse-geocode --target=postgresql:///luftdaten_meta --target=json+stream://sys.stderr # Read station information from RDBMS database (PostgreSQL) and format for Grafana Worldmap Panel luftdatenpumpe stations --source=postgresql:///luftdaten_meta --target=json.grafana.kn+stream://sys.stdout Live data examples (InfluxDB): # Store into InfluxDB running on "localhost" luftdatenpumpe readings --station=28,1071 --target=influxdb://localhost:8086/luftdaten_info # Store into InfluxDB, with UDP luftdatenpumpe readings --station=28,1071 --target=udp+influxdb://localhost:4445/luftdaten_info # Store into InfluxDB, with authentication luftdatenpumpe readings --station=28,1071 --target=influxdb://username:password@localhost:8086/luftdaten_info Archive data examples (InfluxDB): # Mirror archive of luftdaten.info wget --mirror --continue http://archive.luftdaten.info/ --limit-rate=1.5M wget --mirror --continue http://archive.luftdaten.info/ --accept-regex='2018-0[6789]' wget --mirror --continue --no-host-directories --directory-prefix=/var/spool/archive.luftdaten.info http://archive.luftdaten.info/ # Ingest station information from CSV archive files, store into PostgreSQL luftdatenpumpe stations --source=file:///var/spool/archive.luftdaten.info --target=postgresql:///luftdaten_meta --reverse-geocode --progress # Ingest readings from CSV archive files, store into InfluxDB luftdatenpumpe readings --source=file:///var/spool/archive.luftdaten.info --station=483 --sensor=988 --target=influxdb://localhost:8086/luftdaten_info --progress Live data examples (MQTT): # Publish data to topic "luftdaten.info" at MQTT broker running on "localhost" luftdatenpumpe readings --station=28,1071 --target=mqtt://localhost/luftdaten.info # MQTT publishing, with authentication luftdatenpumpe readings --station=28,1071 --target=mqtt://username:password@localhost/luftdaten.info Combined examples: # Write stations to STDERR and PostgreSQL luftdatenpumpe stations --station=28,1071 --target=json+stream://sys.stderr --target=postgresql:///luftdaten_meta # Write readings to STDERR, MQTT and InfluxDB luftdatenpumpe readings --station=28,1071 --target=json+stream://sys.stderr --target=mqtt://localhost/luftdaten.info --target=influxdb://localhost:8086/luftdaten_info
Setup
Prerequisites
Debian packages:
apt install postgis redis-server redis-tools
Postgres database
Create user and database:
su - postgres createuser --no-createdb --pwprompt hiveeyes createdb --owner hiveeyes ldi_meta
Create read-only user:
psql postgres=# \c ldi_meta ldi_meta=# CREATE ROLE readonly WITH LOGIN PASSWORD 'readonly'; ldi_meta=# GRANT USAGE, SELECT ON ALL SEQUENCES IN SCHEMA public TO readonly; ldi_meta=# GRANT SELECT ON ALL TABLES IN SCHEMA public TO readonly;
Redis cache
This program extensively uses a runtime cache based on Redis. To make this work best, you should enable data durability with your Redis instance.
The append-only file is an alternative, fully-durable strategy for Redis. It became available in version 1.1. You can turn on the AOF in your Redis configuration file (e.g. /etc/redis/redis.conf):
appendonly yes
Python module
pip install luftdatenpumpe
References
Upstream luftdaten.info
Standing on the shoulders of giants
Development
License
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program; if not, see: <http://www.gnu.org/licenses/agpl-3.0.txt>, or write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Content attributions
The copyright of particular images and pictograms are held by their respective owners, unless otherwise noted.
Icons and pictograms
Water Pump Free Icon from Icon Fonts is licensed by CC BY 3.0.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file luftdatenpumpe-0.6.0.tar.gz
.
File metadata
- Download URL: luftdatenpumpe-0.6.0.tar.gz
- Upload date:
- Size: 28.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8c812a0a647326a9cf9d7eb67a43dadbb584196b716e88c5b483ddf15ebbbbc |
|
MD5 | 2b85328498a7456e808a6cd3bdd8f93c |
|
BLAKE2b-256 | 91445db38f47e09df0626824901e9e19250576a7b82bbd6a18446a3d33e84283 |