Skip to content

Commit 8f44a41

Browse files
committed
Update Telegram plugin
1 parent 4799826 commit 8f44a41

16 files changed

Lines changed: 64 additions & 35 deletions

_plugins/telegram.md

Lines changed: 64 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
layout: plugin
33

44
id: telegram
5-
title: OctoPrint-Telegram
6-
description: A plugin to send and react on messages before, during and after a print
7-
via Telegram Messenger.
5+
title: Telegram
6+
description: Control your printer and receive notification messages via Telegram Messenger.
87
authors:
98
- Jacopo Tediosi
109
- Fabian Schlenz
@@ -16,34 +15,56 @@ homepage: https://github.com/jacopotediosi/OctoPrint-Telegram
1615
source: https://github.com/jacopotediosi/OctoPrint-Telegram
1716
archive: https://github.com/jacopotediosi/OctoPrint-Telegram/archive/master.zip
1817

19-
# TODO set this to true if your plugin uses the dependency_links setup parameter to include
20-
# library versions not yet published on PyPi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION!
21-
follow_dependency_links: false
18+
privacypolicy: https://github.com/jacopotediosi/OctoPrint-Telegram/blob/master/PRIVACY.md
2219

2320
tags:
24-
- notification
21+
- control
22+
- filament
23+
- filament runout
24+
- lights
2525
- mobile
26+
- monitor
27+
- monitoring
28+
- notification
29+
- notifications
30+
- power
31+
- print status
2632
- progress
27-
- control
33+
- remote
34+
- remote camera
35+
- telegram
36+
- webcam
2837

2938
screenshots:
30-
- url: /assets/img/plugins/telegram/features1.png
31-
alt: Telegram notifications during print
32-
caption: You can receive the current status with a webcam picture at user-definable
33-
intervals.
34-
- url: /assets/img/plugins/telegram/features3.png
35-
alt: Requesting the current status
36-
caption: You can control OctoPrint via messages. E.g., sending /status lets the plugin
37-
send you the current status.
38-
- url: /assets/img/plugins/telegram/features4.png
39-
alt: Custom keyboards
40-
caption: You can also abort the current print with /abort. A custom keyboard is
41-
shown for confirmation.
42-
- url: /assets/img/plugins/telegram/features5.png
43-
alt: Settings
44-
caption: You can configure lots of settings via OctoPrint's settings. (Or you can
45-
use /settings to change them via Telegram.)
46-
featuredimage: /assets/img/plugins/telegram/features3.png
39+
- url: /assets/img/plugins/telegram/screen_1.png
40+
alt: Screenshot of the "Connection" tab in plugin settings
41+
caption: Screenshot of the "Connection" tab in plugin settings
42+
- url: /assets/img/plugins/telegram/screen_2.png
43+
alt: Screenshot of the "General settings" tab in plugin settings
44+
caption: Screenshot of the "General settings" tab in plugin settings
45+
- url: /assets/img/plugins/telegram/screen_3.png
46+
alt: Screenshot of the "Chats" tab in plugin settings
47+
caption: Screenshot of the "Chats" tab in plugin settings
48+
- url: /assets/img/plugins/telegram/screen_4.png
49+
alt: Screenshot of the "Notification messages" tab in plugin settings
50+
caption: Screenshot of the "Notification messages" tab in plugin settings
51+
- url: /assets/img/plugins/telegram/screen_5.png
52+
alt: Example of the /con and /files commands
53+
caption: Example of the /con and /files commands
54+
- url: /assets/img/plugins/telegram/screen_6.png
55+
alt: Example of a notification message containing photos, videos, and details of the print in progress
56+
caption: Example of a notification message containing photos, videos, and details of the print in progress
57+
- url: /assets/img/plugins/telegram/screen_7.png
58+
alt: Example of file details displayed in response to the /files command
59+
caption: Example of file details displayed in response to the /files command
60+
- url: /assets/img/plugins/telegram/screen_8.png
61+
alt: Example of commands to start, pause, and abort a print job
62+
caption: Example of commands to start, pause, and abort a print job
63+
- url: /assets/img/plugins/telegram/screen_9.png
64+
alt: Example of the /power and /cancelobject commands
65+
caption: Example of the /power and /cancelobject commands
66+
67+
featuredimage: /assets/img/plugins/telegram/logo.png
4768

4869
compatibility:
4970
octoprint:
@@ -55,16 +76,24 @@ attributes:
5576

5677
---
5778

58-
This plugin integrates Telegram Messenger into OctoPrint.
79+
This plugin integrates Telegram Messenger with OctoPrint.
80+
81+
### Features
82+
83+
<ul style="list-style-type:none">
84+
<li>🔔 Receive Telegram messages with print status, including snapshots and videos from your webcams</li>
85+
<li>📡 Remotely control your printer from Telegram (e.g., browsing and uploading files, starting, pausing, and aborting prints, tuning temperatures, etc.)</li>
86+
<li>🔌 Manage connected power devices (printers, lights, heaters, etc.) directly from Telegram</li>
87+
<li>🔐 Configure allowed commands and active notifications for each chat</li>
88+
<li>🧩 Integrations with many other plugins (e.g., manage filaments from Telegram, cancel single objects, control various brands of plugs, etc.)</li>
89+
</ul>
90+
91+
### Documentation
92+
93+
For full installation and usage instructions, available features, configuration guidance, and common troubleshooting steps, please refer to the [plugin’s Wiki](https://github.com/jacopotediosi/OctoPrint-Telegram/wiki).
5994

60-
You can receive automatic notifications with webcam images before and after a print -
61-
and even during a print at customizable intervals, such as at specific heights or after a
62-
certain time (e.g., every 5 mm of height OR every 10 minutes — whichever comes first).
95+
### Support the project
6396

64-
You can also control OctoPrint via messages. For example, send:
65-
- `/status` to receive the current printer status,
66-
- `/abort` to stop the ongoing print,
67-
- `/help` to get a list of all available commands.
97+
This project is distributed for free and maintained entirely by volunteers, who do their best to develop it in their spare time, gather feedback and reports from users, and fix issues.
6898

69-
Please refer to [the documentation on GitHub](https://github.com/jacopotediosi/OctoPrint-Telegram/blob/master/README.md)
70-
to learn how to register a Telegram bot - a required step for this plugin to work.
99+
If you'd like to support the maintainers of this project, you can donate via the [GitHub Sponsor page](https://github.com/sponsors/jacopotediosi) ❤️.
-458 KB
Binary file not shown.
-448 KB
Binary file not shown.
-457 KB
Binary file not shown.
-297 KB
Binary file not shown.
-113 KB
Binary file not shown.
44 KB
Loading
51.3 KB
Loading
64.6 KB
Loading
58.6 KB
Loading

0 commit comments

Comments
 (0)