AQI Telegram Bot
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
aqimon
db
doc
l10n
telegram
twisted/plugins
.gitignore
.project
.pydevproject
LICENSE
README.md
l10n_compile.sh
l10n_update.sh
requirements.txt
run.sh
setup.py

README.md

aqi-telegram-bot

aqi-telegram-bot is AQI monitoring Telegram bot. It's written in Python using Twisted framework.

Sensor

Currently aqi-telegram-bot supports SDS011 Laser PM2.5 Sensor produced by Nova.

Installation

aqi-telegram-bot runs on Python 3.4 and above.

Clone the repo in the directory of your choice using git:

git clone https://github.com/3cky/aqi-telegram-bot aqi-telegram-bot-git
cd aqi-telegram-bot-git

Next, install all needed Python requirements using pip package manager:

pip install --upgrade -r ./requirements.txt

Then install aqi-telegram-bot itself:

python setup.py install

Configuration

Before run this bot, you will have to create a configuration file. You could use provided doc/config.ini as example. Minimal configuration includes specifying Telegram token and sensor serial port and speed.

Run

Run aqi-telegram-bot by command twistd -n aqi-telegram-bot -c /path/to/config.ini.

Commands

Use /help to get list of available commands.