Skip to content

Commit

Permalink
Prepare release and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
derpicknicker1 committed Jan 10, 2017
1 parent 2b51b20 commit 6615957
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This plugin integrates Telegram Messenger with Octoprint. It sends messages (with photos if available) on print start, end and failure. Also it sends messages during the print at configurable intervals. That way you don't have to remember to regularly have a look at the printing process.
Also, you can control Octoprint via messages (settings, start a print and much more). Send `/status` to get the current printer status or `/abort` to abort the current print. Send `/help` for a list of all recognized commands. You may also use this bot in groups.

**Lates release: [1.4.1](https://github.com/fabianonline/OctoPrint-Telegram/releases)**
**Latest release: [1.4.2](https://github.com/fabianonline/OctoPrint-Telegram/releases)**

## Contents
* [Installation](#installation)
Expand Down Expand Up @@ -103,6 +103,8 @@ Congratulations! Your printer is now connected to your Telegram bot.<br><br><br>
Configuration is done via the Octoprint settings dialog. Note that only admin users will be able to change user or token settings.

### General
**The paragraph numbers below correspond to the numbers in the picture!**

1. Token: Enter your bot token here. You got this from @botfather, when you [created](#create-telegram-bot) your bot there. *(admin users only)*


Expand All @@ -125,6 +127,8 @@ Configuration is done via the Octoprint settings dialog. Note that only admin us
### Users
There are users (private chat with single user) or groups you will see in the list of known chats. These settings are only accessible by admin users.

**The paragraph numbers below correspond to the numbers in the picture!**

1. When clicking the *command* icon, a dialog with a list of checkboxes for every accepted command will open. Check a box to enable the user/group to use the command. When done, close the dialog. Don't forget to enable general command execution in `3.`

2. By clicking on the *notification* icon, a dialog with a list of checkboxes for every known notification event will open. Checked notifications will be send to the user/group. When done, close the dialog. Don't forget to activate general notification in `3.`
Expand Down Expand Up @@ -159,6 +163,8 @@ There are users (private chat with single user) or groups you will see in the li
### Notifications
In this section you can configure the content of the notification messages.

**The paragraph numbers below correspond to the numbers in the picture!**

1. These three buttons will open dialogs which provide you informations about using markup, variables and emojis in the messages.

2. Enter the text you want to send when the specific event happens.
Expand Down
2 changes: 1 addition & 1 deletion octoprint_telegram/templates/telegram_settings.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
<input type="checkbox" data-bind="checked: settings.settings.plugins.telegram.fileOrder" />
Sort files by time of upload
</label>
<span class="help-block"><small>If this is checked, the files will be listed in order of their upload time (youngest first) when using /files command in Telegram messenger. Otherwise they will be listed by name. </small></span>
<span class="help-block"><small>If this is checked, the files will be listed in order of their upload time (youngest first) when using /files command in Telegram messenger. Otherwise they will be listed by name. You can also change this option in Telegram file dialog.</small></span>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
plugin_name = "OctoPrint-Telegram"

# The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
plugin_version = "1.4.1"
plugin_version = "1.4.2"

# The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
# module
Expand Down

0 comments on commit 6615957

Please sign in to comment.