aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2020-03-27 21:47:41 +0100
committerGravatar Christian Hesse <mail@eworm.de>2020-03-27 22:12:49 +0100
commit8c3489761ee7c31fbe01d93b9e648bbc671f6bce (patch)
tree7fbf9adf31afdfe81bacf059c4197b14475b9f71
parente1377cbd927e0bca631c1d904d3172878f307410 (diff)
add doc/leds-mode.md
-rw-r--r--doc/leds-mode.md50
-rw-r--r--leds-day-mode1
-rw-r--r--leds-night-mode1
-rw-r--r--leds-toggle-mode1
4 files changed, 53 insertions, 0 deletions
diff --git a/doc/leds-mode.md b/doc/leds-mode.md
new file mode 100644
index 0000000..e0f7cf3
--- /dev/null
+++ b/doc/leds-mode.md
@@ -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)
diff --git a/leds-day-mode b/leds-day-mode
index 0b50648..cd59bab 100644
--- a/leds-day-mode
+++ b/leds-day-mode
@@ -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;
diff --git a/leds-night-mode b/leds-night-mode
index 6a973e4..9048a83 100644
--- a/leds-night-mode
+++ b/leds-night-mode
@@ -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;
diff --git a/leds-toggle-mode b/leds-toggle-mode
index 7518ef4..5f67979 100644
--- a/leds-toggle-mode
+++ b/leds-toggle-mode
@@ -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;