aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2020-03-27 21:50:18 +0100
committerGravatar Christian Hesse <mail@eworm.de>2020-03-27 22:12:49 +0100
commited2718da2a7beb6b1b1936681c531ec71612320f (patch)
tree177750b43088f6389398103dd600092c78db95df
parent747af21bea685d75ea524c97fcb6e8d44b466c86 (diff)
add doc/sms-action.md
-rw-r--r--doc/sms-action.md49
-rw-r--r--sms-action1
2 files changed, 50 insertions, 0 deletions
diff --git a/doc/sms-action.md b/doc/sms-action.md
new file mode 100644
index 0000000..df9e14f
--- /dev/null
+++ b/doc/sms-action.md
@@ -0,0 +1,49 @@
+Act on received SMS
+===================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+RouterOS can act on received SMS. Reboot the device from remote or do
+whatever is required.
+
+A broadband interface with SMS support is required.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+ $ScriptInstallUpdate sms-action;
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, this is the only parameter:
+
+* `SmsAction`: an array with pre-defined actions
+
+Then enable SMS actions:
+
+ / tool sms set allowed-number=+491234567890 receive-enabled=yes secret=s3cr3t;
+
+Usage and invocation
+--------------------
+
+Send a SMS from allowed number to your device's phone number:
+
+ :cmd s3cr3t script sms-action action=reboot;
+
+The value given by "`action=`" is one of the pre-defined actions from
+`SmsAction`.
+
+See also
+--------
+
+* [Forward received SMS](sms-forward.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)
diff --git a/sms-action b/sms-action
index 4442baf..2384167 100644
--- a/sms-action
+++ b/sms-action
@@ -3,6 +3,7 @@
# Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de>
#
# run action on received SMS
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/sms-action.md
:global SmsAction;