aboutsummaryrefslogtreecommitdiff
path: root/docs/anduril-manual.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/anduril-manual.md')
-rw-r--r--docs/anduril-manual.md102
1 files changed, 75 insertions, 27 deletions
diff --git a/docs/anduril-manual.md b/docs/anduril-manual.md
index b40b454..479289f 100644
--- a/docs/anduril-manual.md
+++ b/docs/anduril-manual.md
@@ -143,17 +143,13 @@ manufacturer's request. This typically includes:
- `Ramp -> 3C`: Toggle smooth or stepped [ramp shape](#ramping--stepped-ramping-modes).
- `Ramp -> 5H`: [Sunset timer](#sunset-timer).
- - `Off -> 3H`: Access the [strobe/mood modes](#strobe--mood-modes).
- - `Off -> 7C/7H`: Change the [aux LED brightness](#aux-leds--button-leds).
+ - `Off -> 7C/7H`: Change the [aux LED pattern](#aux-leds--button-leds).
- `Lockout -> 7C/7H`: Change the [aux LED pattern](#aux-leds--button-leds).
-If your light uses Extended Simple UI, *think twice about letting kids use it*,
-because the strobe/mood modes were not intended to be used in simple mode, and
-can reach full power with no thermal regulation.
-
-It is likely that strobe/mood modes will be removed from Extended Simple UI in
-the future, for safety reasons, or maybe have already been removed. But that
-doesn't help with older firmware, so be careful.
+Old versions (before 2024-08) also allowed access to strobe/mood modes, which
+can be dangerous, so if you have one of those, *think twice about letting kids
+use it*. Those modes were never intended to be child-safe, and can reach full
+power with no thermal regulation.
### Configuring Simple UI
@@ -178,12 +174,17 @@ and they will carry over to Simple UI:
- ramp style (smooth / stepped)
- smooth ramp speed
- ramp-after-moon style
+ - smooth steps
- memory settings
- auto-lock settings
- aux LED settings
- voltage calibration
+ - post-off voltage display
+ - aux led low and high ramp levels
- thermal regulation settings
- hardware-specific "misc menu" settings
+ - channel modes
+ - channel mode for number blinks
Advanced UI
@@ -192,6 +193,11 @@ Advanced UI
Most of the information below this is for the Advanced UI. Anything not
already noted above is blocked in the Simple UI.
+To check which UI the user is in, Simple UI or Advanced UI, enter battery check
+mode with `3C` from Off. In Simple UI, the battery voltage is displayed only
+once, but in Advanced UI, the battery voltage is checked and displayed
+repeatedly.
+
To return to Simple UI from advanced UI, enter 10C while the light is off.
@@ -258,8 +264,8 @@ While the light is on, a few actions are available:
4 = Quarter speed, ~10s.
- `10C`: Activate manual memory and save the current brightness.
-<a name="ramp-extras-config-menu">
- - `10H`: Ramp extras config menu.
+ Also saves current channel mode, on multi-channel lights.
+ - `10H`: Ramp extras config menu. <a name="ramp-extras-config-menu" />
- Item 1: Disable manual memory and go back to automatic memory.
(doesn't matter what value the user enters at the prompt)
- Item 2: Configure the manual memory timer.
@@ -422,14 +428,30 @@ In more detail, this is what each blinky / utility mode does:
### Battery check:
-Blinks out the battery voltage per cell. Full is 4.2V, empty is
-about 3.0V. The light blinks the whole-number digit first, pauses,
-then blinks out the "tenths" digit. Then a longer pause, and it
-repeats.
-So for 4.2V, it would be "blink-blink-blink-blink .. blink-blink".
+Blinks out the battery voltage per cell. Full is 4.20V, empty is
+about 3.00V. The light blinks the whole-number digit first, pauses,
+then blinks out the "tenths" digit, pauses, then blinks out the "hundredths"
+digit, in 0.02V steps. So for 4.16V, it would be "4 blinks, 1 blink,
+6 blinks". Then if it is in Advanced UI, it pauses for a bit longer and
+repeats. In Simple UI, it turns off after one readout.
A "zero" digit is represented by a very quick blink.
+The battery check format has changed a few times:
+
+ - For Anduril 2 from 2024-04 or later, the battery voltage resolution is
+ 0.02V steps (the last digit can be 0, 2, 4, 6, or 8).
+
+ - For Anduril 2 from 2023-12 or later, the battery voltage resolution is
+ 0.025V steps (the last digit can be 0, 2, 5, or 7).
+
+ - For Anduril 2 from 2023-12 or earlier, the battery voltage resolution is
+ 0.1V, so the light blinks the whole-number digit first, pauses, then blinks
+ out the "tenths" digit. Then a longer pause, and it repeats.
+
+ - On old attiny85 lights with only 8 KiB of ROM, battery voltage resolution
+ is 0.1V, even on newer versions of Anduril.
+
On lights with more than one set of LEDs, pressing `3C` during batt
check mode can select which set of LEDs (which channel mode) it uses
to blink out numbers.
@@ -454,11 +476,23 @@ The voltage config menu has these settings:
`12C`: +0.25V
`13C`: +0.30V
- 2. Post-off voltage display timeout. (only on lights with RGB aux)
+ 2. Post-off voltage display timeout. (only on lights with RGB aux)
This setting determines how many seconds the RGB aux LEDs
display the voltage color after the torch goes to sleep. Click
once per desired second, or zero times to turn this function
- off.
+ off. The default is 4 seconds.
+
+ 3. Aux low ramp level. Controls behavior of aux button LEDs while the main
+ LEDs are on. Below this ramp level, button LEDs will not be lit up while
+ the main LEDs are on. At or above this level, button LEDs light up at the
+ "low" brightness level. Setting it to 0 keeps the button LEDs off
+ completely while the main LEDs are on.
+ Also controls brightness of post-off voltage display.
+
+ 4. Aux high ramp level. At or above this ramp level, button LEDs light up at
+ the "high" brightness level. Setting it to 0 disables button's high aux
+ mode while the main LEDs are on.
+ Also controls brightness of post-off voltage display.
### Temperature check:
@@ -640,6 +674,8 @@ This assumes the light has a ramp 150 levels long. Strobe modes start
at the ramp size plus 1, so it may be different if a light has a
different ramp size.
+In Tactical Mode, the aux LED settings are inherited from Lockout Mode.
+
Configuration Menus
-------------------
@@ -956,15 +992,22 @@ This setting only applies to modes with channel ramping (i.e. tint
ramping), and only when that mode uses the default `3H` event handler.
Custom channel modes may work differently.
+On lights with channel modes, manual memory (`Ramp -> 10C`) saves the
+current brightness *and* channel mode.
+
+
FAQ
---
+
* Q: Why do the aux LEDs come on whenever I switch the light off, regardless
-of aux settings?
+ of aux settings?
* A: This is the post-off voltage display feature. It can be configured or
-disabled under [battery check](#battery-check) mode.
+ disabled under [battery check](#battery-check) mode.
+
* Q: What can I do to contribute to Anduril development?
* A: See [Contributing](https://github.com/ToyKeeper/anduril#contributing).
+
UI Reference Table
------------------
@@ -1019,6 +1062,7 @@ This is a table of all button mappings in Anduril, in one place:
| | | | 2: ceiling
| | | | 3: speed / steps
| Ramp | Full | `10C` | Turn on manual memory and save current brightness
+| | | | (and current channel mode)
| Ramp | Full | `10H` | Ramp Extras config menu:
| | | | 1: switch to automatic mem, not manual mem
| | | | 2: set manual mem timeout
@@ -1077,14 +1121,18 @@ This is a table of all button mappings in Anduril, in one place:
| Batt check | Full | `3C` | Next channel mode (for number blinks only)
| Batt check | Full | `7H` | Voltage config menu
| | | | 1: voltage correction factor
-| | | | ...
-| | | | 5: -0.10V
-| | | | 6: -0.05V
-| | | | 7: no correction
-| | | | 8: +0.05V
-| | | | 9: +0.10V
-| | | | ...
+| | | | ... 5: -0.10V
+| | | | ... 6: -0.05V
+| | | | ... 7: no correction
+| | | | ... 8: +0.05V
+| | | | ... 9: +0.10V
| | | | 2: post-off voltage display seconds
+| | | | 3: aux low ramp level
+| | | | ... 0: disabled
+| | | | ... 1+: light up at this ramp level
+| | | | 4: aux high ramp level
+| | | | ... 0: disabled
+| | | | ... 1+: brighter at this ramp level
| Mode | UI | Button | Action
| :--- | :-- | ------: | :-----