diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 62 |
1 files changed, 48 insertions, 14 deletions
@@ -1,31 +1,65 @@ # inverter-bot -This is a Telegram bot for querying information from an InfiniSolar V family of hybrid solar inverters, in particular -inverters supported by **isv** utility, which is an older version of **infinisolarctl** from **infinisolar-tools** -package. +This is a Telegram bot for querying information from an InfiniSolar V family of hybrid solar inverters. It supports querying general status, such as battery voltage or power usage, printing amounts of energy generated in the last days, dumping status or rated information and more. It requires Python 3.6+ or so. +## Requirements + +- **`inverterd`** from [inverter-tools](https://github.com/gch1p/inverter-tools) +- **[`inverterd`](https://pypi.org/project/inverterd/)** python library +- Python 3.6+ or so + ## Configuration -Configuration is stored in `config.ini` file in `~/.config/inverter-bot`. +The bot accepts following parameters: + +* ``--token`` — your telegram bot token (required) +* ``--users-whitelist`` — space-separated list of IDs of users who are allowed + to use the bot (required) +* ``--inverterd-host`` (default is `127.0.0.1`) +* ``--inverterd-port`` (default is `8305`) +* ``--shell-admin`` -Config example: +## Launching with systemd + +This is tested on Debian 10. Something might differ on other systems. + +Create environment configuration file `/etc/default/inverter-bot`: +``` +TOKEN="YOUR_TOKEN" +USERS="ID ID ID ..." +OPTS="" # here you can pass other options such as --inverterd-host ``` -token=YOUR_TOKEN -admins= - 123456 ; admin id - 000123 ; another admin id -shell_admin=123456 ; admin that's allowed to spawn shell commands -isv_bin=/path/to/isv -use_sudo=0 + +Create systemd service file `/etc/systemd/system/inverter-bot.service` with the following content (changing stuff like paths): + +```systemd +[Unit] +Description=inverter bot +After=network.target + +[Service] +EnvironmentFile=/etc/default/inverter-bot +User=user +Group=user +Restart=on-failure +ExecStart=python3 /home/user/inverter-bot/inverter-bot --token $TOKEN --users-whitelist $USERS $PARAMS +WorkingDirectory=/home/user/inverter-bot + +[Install] +WantedBy=multi-user.target ``` -Only users in `admins` are allowed to use the bot. +Then enable and start the service: +``` +systemctl enable inverter-bot +systemctl start inverter-bot +``` ## License -BSD-2c +MIT |