diff options
| author |  Christian Hesse <mail@eworm.de> | 2020-03-27 22:15:43 +0100 |
|---|---|---|
| committer | Christian Hesse <mail@eworm.de> | 2020-03-27 22:15:43 +0100 |
| commit | 54a8f2839dd32d9c8bd60c2edbbca3606b250bbb (patch) | |
| tree | b8164b53f21696c30869ca2b4c3699efd3eb1579 /doc/mode-button.md | |
| parent | a87fbb4be1e1e090b01db9eebd7799a0e1d62771 (diff) | |
| parent | 1d93e92dcda753b855e89295f74dafae4743bb80 (diff) | |
Merge branch 'documentation'
Diffstat (limited to 'doc/mode-button.md')
| -rw-r--r-- | doc/mode-button.md | 40 |
1 files changed, 40 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) |