Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aschuma/air_tweets
Stay informed on air quality with this simple bot, which posts real-time updates from a configurable sensor on the https://sensor.community network to Twitter and Mastodon. See it in action by following #feinstaub and #cannstatt on https://mastodon.online/@aschuma or https://twitter.com/twaschuma
https://github.com/aschuma/air_tweets
air-quality airrohr bot feinstaub feinstaubalarm luftdaten mastodon particulate-matter pm10 python sensor-data twitter
Last synced: 10 days ago
JSON representation
Stay informed on air quality with this simple bot, which posts real-time updates from a configurable sensor on the https://sensor.community network to Twitter and Mastodon. See it in action by following #feinstaub and #cannstatt on https://mastodon.online/@aschuma or https://twitter.com/twaschuma
- Host: GitHub
- URL: https://github.com/aschuma/air_tweets
- Owner: aschuma
- License: mit
- Created: 2018-01-21T21:00:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T05:49:28.000Z (7 months ago)
- Last Synced: 2024-04-12T13:27:15.160Z (7 months ago)
- Topics: air-quality, airrohr, bot, feinstaub, feinstaubalarm, luftdaten, mastodon, particulate-matter, pm10, python, sensor-data, twitter
- Language: Python
- Homepage:
- Size: 471 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
:::. ::: :::::::.. ::::::::::::.:: . .:::.,:::::: .,:::::::::::::::::: .::::::.
;;`;; ;;; ;;;;``;;;; ;;;;;;;;''''';;, ;; ;;;' ;;;;'''' ;;;;'''';;;;;;;;'''';;;` `
,[[ '[[, [[[ [[[,/[[[' [[ '[[, [[, [[' [[cccc [[cccc [[ '[==/[[[[,
c$$$cc$$$c $$$ $$$$$$c $$ Y$c$$$c$P $$"""" $$"""" $$ ''' $
888 888, 888 888b "88bo, 88, "88"888 888oo,__ 888oo,__ 88, 88b dP
YMM ""` MMM MMMM "W" MMM "M "M" """"YUMMM""""YUMMM MMM "YMmMY"
```
# Tweets air quality measurement results of particulate matter (Feinstaub) (http://luftdaten.info)
This source code is for a Mastodon or Twitter bot that monitors particulate matter (Feinstaub) for a single sensor from the https://sensor.community network. The bot will automatically publish a tweet when the PM10 particulate matter exceeds a configurable threshold, such as 50 µg/m³."
A tweet might look like this:
This repository provides a cron job written in python 3. After a tweet submission no further tweets
are created for a configurable period.
# Deprecation of Twitter Support
⚠️ The Twitter support will be deprecated some time in the future. Please refer to the ['r3.0.0'](https://github.com/aschuma/air_tweets/tree/r3.0.0) tag to access the latest functioning code for Twitter.
# Installation
- Create a twitter account, obtain an access token, see https://developer.twitter.com/en/docs/basics/authentication/guides/access-tokens for further details.
- Make sure python 3 is installed on your dev machine.
- Clone this repository
- Create a virtual environment, you may obtain more information about the steps below here: http://docs.python-guide.org/en/latest/dev/virtualenvs/
```
virtualenv venv -p /usr/bin/python3
source venv/bin/activate
pip3 install -r requirements.txt
```
- Copy the file ```config.py-template``` to ```config.py```, adjust the setup. At least you should alter the following values as starting point.
```
# database, last tweet timestamp
conf_storage = "/tmp/.air_tweet"
# the sensor ids
conf_particle_sensor_id = 609
conf_temperature_sensor_id = 610
# url used to fetch the avg sensor of the last hour
conf_url_pm_sensor = "http://api.luftdaten.info/static/v2/data.1h.json"
conf_url_th_sensor = "http://api.luftdaten.info/static/v2/data.1h.json"
# sensor graph to embed in the tweet, provided for example by a graphana image renderer
conf_luftdaten_graph_url = "http://192.168.0.43:3000/render/d-solo/eDF152mRk/twitter?panelId=2&orgId=1&from={}&to={}&width=800&height=500&tz=UTC%2B02%3A00"
conf_luftdaten_graph_mime_type = "image/png"
# PM 10 limit
conf_limit_pm_10_0 = 50
# quiet period after a tweet has been published
conf_quiet_period_in_hours = 6
# stuff to embed in the tweet
conf_luftdaten_map_url = "http://deutschland.maps.luftdaten.info/#13/48.8066/9.2372"
conf_msg_preamble = "#feinstaub in #cannstatt:"
# twitter credentials
twitter_enabled = True
twitter_consumer_key = 'Abq...'
twitter_consumer_secret = 'nep...'
twitter_access_token = '43...'
twitter_access_token_secret = 'pq...'
# mastodon credentials
mastodon_enabled = True
mastodon_api_base_url = 'https://mastodon.online'
mastodon_access_token = 'sE98...'
```
- Setup a cron job
```
*/15 * * * * cd /home/pi/projects/air_tweets && venv/bin/python tweet.py > /dev/null 2>&1
```
# Contribution
Please feel free to issue a bug report or submit a PR. Any helping hand is welcome.
Be aware that my primary coding language is Java. So currently some code portions might not follow python best practices.