diff options
author | Christian Hesse <mail@eworm.de> | 2020-03-27 21:48:25 +0100 |
---|---|---|
committer | Christian Hesse <mail@eworm.de> | 2020-03-27 22:12:49 +0100 |
commit | 5594ffd69afb9b72e73a62103cd657d51d4b0366 (patch) | |
tree | 4081f2d09eb20d8f3d52aca5e89ebcca5b4a8242 | |
parent | 8c3489761ee7c31fbe01d93b9e648bbc671f6bce (diff) |
add doc/mode-button.md
-rw-r--r-- | doc/mode-button.md | 40 | ||||
-rw-r--r-- | mode-button-event | 1 | ||||
-rw-r--r-- | mode-button-scheduler | 1 |
3 files changed, 42 insertions, 0 deletions
diff --git a/doc/mode-button.md b/doc/mode-button.md new file mode 100644 index 0000000..5018d6e --- /dev/null +++ b/doc/mode-button.md @@ -0,0 +1,40 @@ +Mode botton with multiple presses +================================= + +[◀ Go back to main README](../README.md) + +Description +----------- + +These scripts extend the functionality of mode button. Instead of just one +you can trigger several actions by pressing the mode button several times. + +The hardware needs to have a mode button, see +`/ system routerboard mode-button`. + +Requirements and installation +----------------------------- + +Just install the scripts: + + $ScriptInstallUpdate mode-button-event,mode-button-scheduler; + +Then configure the mode-button to run `mode-button-event`: + + / system routerboard mode-button set enabled=yes on-event="/ system script run mode-button-event;"; + +Configuration +------------- + +The configuration goes to `global-config-overlay`, the only parameter is: + +* `ModeButton`: an array with defined actions + +Usage and invocation +-------------------- + +Press the mode button. :) + +--- +[◀ Go back to main README](../README.md) +[▲ Go back to top](#top) diff --git a/mode-button-event b/mode-button-event index 91b0edb..4768e09 100644 --- a/mode-button-event +++ b/mode-button-event @@ -3,6 +3,7 @@ # Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de> # # run on mode-button event and count button presses +# https://git.eworm.de/cgit/routeros-scripts/about/doc/mode-button.md :global ModeButton; diff --git a/mode-button-scheduler b/mode-button-scheduler index 2b6f083..03f673b 100644 --- a/mode-button-scheduler +++ b/mode-button-scheduler @@ -3,6 +3,7 @@ # Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de> # # act on multiple mode-botton presses from scheduler +# https://git.eworm.de/cgit/routeros-scripts/about/doc/mode-button.md :global ModeButton; |