aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mode-button.md
blob: 5018d6e7ee4a65b9e6f777f561b2a00f5167e2be (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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)