Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 4.62 KB

Installation.md

File metadata and controls

123 lines (90 loc) · 4.62 KB
Raw

Installation

Create a Telegram bot

  1. Search for the @BotFather username in your Telegram application
  2. Click Start to begin a conversation with @BotFather
  3. Send /newbot to @BotFather. @BotFather will respond with various questions.
  4. Send your bot’s name to @BotFather. Your bot’s name can be anything. Note that this is not your bot’s Telegram @username. You will create the username in step 5.
  5. Send your bot’s username to @BotFather. BotFather will respond:
  6. Begin a conversation with your bot by clicking on the t.me/ link in the response of @BotFather or add the bot to a group with @<bot-username>. Then click Start at the bottom of your Telegram application or type /start if your bot is in a group. Your newly-created bot will appear in the chat list on the left side of the application.

Get a Telegram API access token

Telegram’s @BotFather bot sent you an API access token when you created your bot. See the @BotFather response in step 5 of the previous section for where to find your token. If you can’t find the API access token, create a new token with the following steps below.

  1. Send /token to @BotFather
  2. Select the relevant bot at the bottom of your Telegram application. @BotFather responds with a new API access token:
You can use this token to access HTTP API:
<API-access-token>

For a description of the Bot API, see this page: https://core.telegram.org/bots/api

Get your Telegram chat ID

  1. Paste the following link in your browser. Replace <API-access-token> with the API access token that you identified or created in the previous section:
https://api.telegram.org/bot<API-access-token>/getUpdates?offset=0

  1. Send a message to your bot in the Telegram application. The message text can be anything (if youre bot is in a group then send a comand like /state). Your chat history must include at least one message to get your chat ID.

  2. Refresh your browser.

  3. Identify the numerical chat ID by finding the id inside the chat JSON object. In the example below, the chat ID is 123456789.

{
   "ok":true,
   "result":[
      {
         "update_id":XXXXXXXXX,
         "message":{
            "message_id":2,
            "from":{
               "id":123456789,
               "first_name":"Mushroom",
               "last_name":"Kap"
            },
            "chat":{
               "id":123456789,
               "first_name":"Mushroom",
               "last_name":"Kap",
               "type":"private"
            },
            "date":1487183963,
            "text":"hi"
         }
      }
   ]
}

Install The script on a Raspberry Pi

First of all check you have added [display_status] to your Mainsail/Fluidd Config (/home/pi/klipper_config/mainsail.conf for example). This is normally used to enable LCD Display.

Download and install the plugin

If that's the first time you use it (or if you deleted the folder) do this :

cd ~
git clone https://github.com/Raabi91/moonraker-telegram
cd moonraker-telegram

then install the script with

./scripts/install.sh

During the installation you will be asked for the config path of Moonraker. Enter the full path here. If you have only one instance of moonraker then it is by default /home/pi/klipper_config

You will also be asked for if you have multiple installations:

  • If you have only one installation, you just have to confirm with enter.
  • if you want to have multiple installations, have a look at the FAQ.

Then edit your config (telegram_config.sh) using the Mainsail or Fluidd web interface. Only edit the variable contents between the "".

Then add this to Moonraker configuration file for the Update Manager (default: /home/pi/klipper_config/moonraker.conf):

[update_manager client moonraker-telegram]
type: git_repo
path: /home/pi/moonraker-telegram
origin: https://github.com/Raabi91/moonraker-telegram.git
env: /home/pi/.moonraker-telegram-env/bin/python
requirements: scripts/moonraker-telegram-requirements.txt
install_script: scripts/install.sh

When you are done, restart monraker-telegram with:

sudo systemctl restart moonraker-telegram

(I also suggest a full reboot if needed).

The shell script that sends messages uses the bc program. Minimal Raspberry Pi installations will not have this installed by default.

If your /state command shows 0.0% and 00:00:00, install the bc program sudo apt install bc.

Printing myprint.gcode at 0.0%. Current Time 00:24:29. Remaining Time 00:00:00