add doc/mode-button.md
This commit is contained in:
parent
8c3489761e
commit
5594ffd69a
|
@ -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)
|
|
@ -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;
|
||||
|
||||
|
|
|
@ -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;
|
||||
|
||||
|
|
Loading…
Reference in New Issue