aboutsummaryrefslogtreecommitdiffstats
path: root/doc/telegram-chat.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/telegram-chat.md')
-rw-r--r--doc/telegram-chat.md37
1 files changed, 34 insertions, 3 deletions
diff --git a/doc/telegram-chat.md b/doc/telegram-chat.md
index 391042d..1e6f70f 100644
--- a/doc/telegram-chat.md
+++ b/doc/telegram-chat.md
@@ -1,6 +1,13 @@
Chat with your router and send commands via Telegram bot
========================================================
+[![GitHub stars](https://img.shields.io/github/stars/eworm-de/routeros-scripts?logo=GitHub&style=flat&color=red)](https://github.com/eworm-de/routeros-scripts/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/eworm-de/routeros-scripts?logo=GitHub&style=flat&color=green)](https://github.com/eworm-de/routeros-scripts/network)
+[![GitHub watchers](https://img.shields.io/github/watchers/eworm-de/routeros-scripts?logo=GitHub&style=flat&color=blue)](https://github.com/eworm-de/routeros-scripts/watchers)
+[![required RouterOS version](https://img.shields.io/badge/RouterOS-7.15-yellow?style=flat)](https://mikrotik.com/download/changelogs/)
+[![Telegram group @routeros_scripts](https://img.shields.io/badge/Telegram-%40routeros__scripts-%2326A5E4?logo=telegram&style=flat)](https://t.me/routeros_scripts)
+[![donate with PayPal](https://img.shields.io/badge/Like_it%3F-Donate!-orange?logo=githubsponsors&logoColor=orange&style=flat)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)
+
[⬅️ Go back to main README](../README.md)
> ℹ️ **Info**: This script can not be used on its own but requires the base
@@ -46,6 +53,8 @@ parameters:
Usage and invocation
--------------------
+### Activating device(s)
+
This script is capable of chatting with multiple devices. By default a
device is passive and not acting on messages. To activate it send a message
containing `! identity` (exclamation mark, optional space and system's
@@ -63,6 +72,21 @@ act on your commands.
Send a single exclamation mark or non-existent identity to make all
devices passive again.
+### Reply to message
+
+Let's assume you received a message from a device before, and want to send
+a command to that device. No need to activate it, you can just reply to
+that message.
+
+![reply to message](telegram-chat.d/03-reply.avif)
+
+Associated messages are cleared on device reboot.
+
+### Ask for devices
+
+Send a message with a single question mark (`?`) to query for devices
+currenty online. The answer can be used for command via reply then.
+
Known limitations
-----------------
@@ -83,6 +107,14 @@ scripting capabilities. Try to print what you want to act on...
/ip/address/remove [ find where interface=eth ];
+What does work is using the persistent ids:
+
+ /ip/address/print show-ids;
+
+The output contains an id starting with asterisk that can be used:
+
+ /ip/address/remove *E;
+
### Mind command runtime
The command is run in background while the script waits for it - about
@@ -98,9 +130,8 @@ send information on its own. Something like this should do the job:
### Output size
-RouterOS is limited in reading file content to a size of about four
-kilobytes. Reading larger files does just fail, and that is also the limit
-for command output.
+Telegram messages have a limit of 4096 characters. If output is too large it
+is truncated, and a warning is added to the message.
### Sending commands to a group