routeros-scripts/doc/mode-button.md

69 lines
1.9 KiB
Markdown
Raw Normal View History

2020-08-13 11:07:40 +00:00
Mode button with multiple presses
2020-03-27 20:48:25 +00:00
=================================
[⬅️ Go back to main README](../README.md)
2020-03-27 20:48:25 +00:00
> **Info**: This script can not be used on its own but requires the base
2022-02-11 22:34:39 +00:00
> installation. See [main README](../README.md) for details.
2020-03-27 20:48:25 +00:00
Description
-----------
This script extend the functionality of mode button. Instead of just one
2020-03-27 20:48:25 +00:00
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`. Starting with RouterOS 6.47beta60 you
can configure the reset button to act the same, see
`/system/routerboard/reset-button`.
2020-03-27 20:48:25 +00:00
Copy this code to terminal to check:
```
:if ([ :len [ /system/routerboard/mode-button/print as-value ] ] > 0) do={
:put "Mode button is supported.";
} else={
:if ([ :len [ /system/routerboard/reset-button/print as-value ] ] > 0) do={
:put "Mode button is not supported, but reset button is.";
} else={
:put "Neither mode button nor reset button is supported.";
}
}
```
2020-03-27 20:48:25 +00:00
Requirements and installation
-----------------------------
Just install the script:
2020-03-27 20:48:25 +00:00
$ScriptInstallUpdate mode-button;
2020-03-27 20:48:25 +00:00
Then configure the mode button to run `mode-button`:
2020-03-27 20:48:25 +00:00
/system/routerboard/mode-button/set enabled=yes on-event="/system/script/run mode-button;";
2020-03-27 20:48:25 +00:00
To use the reset button instead:
/system/routerboard/reset-button/set enabled=yes on-event="/system/script/run mode-button;";
2020-03-27 20:48:25 +00:00
Configuration
-------------
2020-10-23 19:33:38 +00:00
The configuration goes to `global-config-overlay`, these are the parameters:
2020-03-27 20:48:25 +00:00
* `ModeButton`: an array with defined actions
2020-10-23 19:33:38 +00:00
* `ModeButtonLED`: led to give visual feedback
2020-03-27 20:48:25 +00:00
> **Info**: Copy relevant configuration from
> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
> your local `global-config-overlay` and modify it to your specific needs.
2020-03-27 20:48:25 +00:00
Usage and invocation
--------------------
Press the mode button. 😜
2020-03-27 20:48:25 +00:00
---
[⬅️ Go back to main README](../README.md)
[⬆️ Go back to top](#top)