add doc/leds-mode.md

This commit is contained in:
Christian Hesse 2020-03-27 21:47:41 +01:00
parent e1377cbd92
commit 8c3489761e
4 changed files with 53 additions and 0 deletions

50
doc/leds-mode.md Normal file
View file

@ -0,0 +1,50 @@
Manage LEDs dark mode
=====================
[◀ Go back to main README](../README.md)
Description
-----------
These scripts control LEDs mode and allow to run your device
completely dark. Hardware support for dark mode is required.
Requirements and installation
-----------------------------
Just install the scripts:
$ScriptInstallUpdate leds-day-mode,leds-night-mode,leds-toggle-mode;
Usage and invocation
--------------------
To switch the device to dark mode:
/ system script run leds-night-mode;
... and back to normal mode:
/ system script run leds-day-mode;
To toggle between the two modes:
/ system script run leds-toggle-mode;
Add these schedulers to switch to dark mode in the evening and back to
normal mode in the morning:
/ system scheduler add interval=1d name=leds-day-mode on-event="/ system script run leds-day-mode;" start-time=07:00:00;
/ system scheduler add interval=1d name=leds-night-mode on-event="/ system script run leds-night-mode;" start-time=21:00:00;
The script `leds-toggle-mode` can be used from [mode button](mode-button.md)
to toggle mode.
See also
--------
* [Mode botton with multiple presses](mode-button.md)
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)

View file

@ -3,5 +3,6 @@
# Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
#
# enable LEDs
# https://git.eworm.de/cgit/routeros-scripts/about/doc/leds-mode.md
/ system leds settings set all-leds-off=never;

View file

@ -3,5 +3,6 @@
# Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
#
# disable LEDs
# https://git.eworm.de/cgit/routeros-scripts/about/doc/leds-mode.md
/ system leds settings set all-leds-off=immediate;

View file

@ -3,6 +3,7 @@
# Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de>
#
# toggle LEDs mode
# https://git.eworm.de/cgit/routeros-scripts/about/doc/leds-mode.md
:if ([ / system leds settings get all-leds-off ] = "never") do={
/ system leds settings set all-leds-off=immediate;