diff options
author | Christian Hesse <mail@eworm.de> | 2020-03-27 22:15:43 +0100 |
---|---|---|
committer | Christian Hesse <mail@eworm.de> | 2020-03-27 22:15:43 +0100 |
commit | 54a8f2839dd32d9c8bd60c2edbbca3606b250bbb (patch) | |
tree | b8164b53f21696c30869ca2b4c3699efd3eb1579 /doc/leds-mode.md | |
parent | a87fbb4be1e1e090b01db9eebd7799a0e1d62771 (diff) | |
parent | 1d93e92dcda753b855e89295f74dafae4743bb80 (diff) |
Merge branch 'documentation'
Diffstat (limited to 'doc/leds-mode.md')
-rw-r--r-- | doc/leds-mode.md | 50 |
1 files changed, 50 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) |