feinstaub-bot

Twitter bot that monitors fine dust pollution for a given area or specific places using luftdaten.info community sensors. Tweets when PM10 emissions surpass 50 µg/m³ or PM2.5 emissions surpass 25 µg/m³. See also further information about fine dust pollution in Germany provided by the German federal environmental protection agency. Inspired by @FeinstaubFR. Tweets look like this:

⚠ Increased fine dust pollution in Leverkusen: Bürrig, Schlebusch, Rheindorf, +1! PM10 4.98 µg/m³ (Eisholz) http://deutschland.maps.luftdaten.info/#14/51.046/7.009

If you'd like to setup this bot for your own city, village or region, just let me know, I'm happy to help!

Existing instances

Twitter accounts that currently use this project:

• @berlinFeinstaub (Berlin)
• @LEVmussleben (Leverkusen)

Installation

You need to have git and nodejs installed.

git clone https://github.com/juliuste/feinstaub-bot.git
cd feinstaub-bot
npm install

Configuration

If you want to adapt the bot to watch your municipalities sensors instead, you can simply do so by changing the config file/s:

config/default.json

{
	"regionName": "Berlin", // name of your region/city as displayed in the tweets
	"twitter": { // your Twitter API credentials **
		"key": "X",
		"key_secret": "X",
		"token": "X",
		"token_secret": "X"
	},
	"thresholds": {
		"PM10": 50, // PM10 limit in µg/m³
		"PM2.5": 25 // PM2.5 limit in µg/m³
	},
	"requestInterval": 5, // interval for the fine dust API checks in minutes
	"notificationInterval": 180, // interval for the tweets (max. 1 tweet per type [PM10 / PM2.5] in 3h) in minutes
	"regions": [ // list of german "Gemeindeschlüssel" keys, can be empty *
		"110000000000"
	],
	"sensors": [
		{
			"id": 817,
			"name": "Rheindorf"
		},
		{
			"id": 3081,
			"name": "Eisholz"
		}
	], // list of additional sensors, can be empty
	"sensorLimit": 2, // number of sensors that have to surpass the threshold in order to trigger the bot (helps avoiding false alarm caused by one malfunctioning sensor)
	"language": "en", // tweet language, currently supported: `de` and `en`
	"debug": false // if true, the script won't send tweets but log to the console in higher frequency instead
}

* If you only know your municipalities 7-digit key, just add '0000' for the 11-digit key. Example (Berlin): 11000000 -> 110000000000. You can give multiple municipality keys.

** Even though you can add your Twitter API credentials in default.json, it's strongly recommended to store them in a seperate file called production.json which should look like this:

{
	"twitter": { // your Twitter API credentials **
		"key": "X",
		"key_secret": "X",
		"token": "X",
		"token_secret": "X"
	}
}

If you want to run the bot using production.json, just execute npm run start.

Contributing

If you found a bug, want to propose a feature or feel the urge to complain about your life, feel free to visit the issues page.