aboutsummaryrefslogtreecommitdiff
path: root/ui/baton/baton.txt
diff options
context:
space:
mode:
Diffstat (limited to 'ui/baton/baton.txt')
-rw-r--r--ui/baton/baton.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/ui/baton/baton.txt b/ui/baton/baton.txt
new file mode 100644
index 0000000..2f0c22f
--- /dev/null
+++ b/ui/baton/baton.txt
@@ -0,0 +1,21 @@
+This is a very simple clone of the Olight Baton interface. It is not
+exact, but it has the basics. Mostly, it exists for the purposes of
+demonstrating how to create interfaces in FSM.
+
+While off:
+
+ - 1 click: Turn on (at memorized level).
+ - Hold: Turn on (at moon level).
+ - 2 clicks: Turn on (at highest level).
+ - 4 clicks: Soft lockout mode.
+
+While on:
+
+ - 1 click: Turn off.
+ - Hold: Change the brightness. Goes up in steps, then wraps around.
+ - 2 clicks: Go to/from highest level.
+
+While locked:
+
+ - 4 clicks: Exit lockout mode.
+