Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 2.03 KB

README.md

File metadata and controls

81 lines (61 loc) · 2.03 KB
Raw

kllipper-tg-bot

Telegram bot for Klipper

Features

  • Printing state change and progress notification
  • Emergency stop, restart, etc commands
  • Custom gcode execution

Installation

Use the following command to enable automatic start-up of systemd user instances

sudo loginctl enable-linger ${USER}

Install pip and virtualenv:

sudo apt-get install python3-pip python3-virtualenv cython

Execute the following commands:

cd ~/
git clone https://github.com/ksergey/klipper-tg-bot.git
cd klipper-tg-bot
./scripts/install.sh

This script will install python packages, create a python virtual environment at ~/klipper-tg-bot-env and install a systemd service file under user.

To manual start or stop service execute the following command:

# start service
systemctl --user start klipper-tg-bot.service

# stop service
systemctl --user stop klipper-tg-bot.service

if you want to capture images (or video) from web camera you should install ffmpeg:

sudo apt-get install ffmpeg

Configuration

After installation you should configure the bot. By default config file placed in user home directory and has name klipper-tg-bot.conf.

Configuration example:

[telegram]
# telegram bot api token from @BotFather (https://t.me/BotFather)
token = 270485614:AAHfiqksKZ8WmR2zSjiQ7_v4TMAKdiHm9T0
# telegram chat id where bot will talk and receive commands. It's could be telegram group or private chat with bot.
# @getmyid_bot (https://t.me/getmyid_bot) could help to obtain that number.
chat_id = 11111

[moonraker]
# address where moonraker service listen
endpoint = 127.0.0.1:7125
# notification events
notification_events = state,progress

[webcam]
# input device for ffmpeg to capture image and video. It's could be url of jpeg stream or path to camera device
# remove the section if you don't have web camera
input = http://127.0.0.1/webcam/?action=stream
# Constant Rate Factor (see https://trac.ffmpeg.org/wiki/Encode/H.264)
crf = 26