~toykeeper/flashlight-firmware/trunk

« back to all changes in this revision

Viewing changes to ToyKeeper/spaghetti-monster/anduril/anduril-manual.txt

  • Committer: Selene Scriven
  • Date: 2014-07-22 23:45:40 UTC
  • Revision ID: ubuntu@toykeeper.net-20140722234540-7jkvx6or9mow8dze
Moved my sources into ToyKeeper/ directory to keep things a little cleaner.
By default, I'll put my personal firmware there to indicate it might not be
as useful for general-purpose use, it's just something I made.
(can move or copy some again later if they end up being interesting to others)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Anduril User Manual
2
 
-------------------
3
 
 
4
 
Anduril is an open-source firmware for flashlights, distributed under 
5
 
the terms of the GPL v3.  The sources can be obtained here:
6
 
 
7
 
  http://tiny.cc/TKAnduril
8
 
  https://bazaar.launchpad.net/~toykeeper/flashlight-firmware/trunk/files/head:/ToyKeeper/spaghetti-monster/anduril/
9
 
 
10
 
 
11
 
Quick Start
12
 
-----------
13
 
 
14
 
After putting a battery in the light and tightening the parts together, 
15
 
the light should quickly blink once to confirm it has power and is now 
16
 
operational.  After that, basic usage is simple:
17
 
 
18
 
  - Click to turn the light on or off.
19
 
  - Hold the button to change brightness.
20
 
  - Release and hold again to change brightness the other way.
21
 
 
22
 
That is all the user needs to know for basic use, but there are many 
23
 
more modes and features available for people who want more.
24
 
 
25
 
Before reading the rest of this manual, it is recommended that users 
26
 
look at the Anduril UI diagram, which should be provided along with the 
27
 
flashlight.
28
 
 
29
 
 
30
 
Ramping / Stepped Ramping Modes
31
 
-------------------------------
32
 
 
33
 
Anduril's normal operation mode uses a smooth ramp or a stepped ramp, 
34
 
depending on which style the user prefers.
35
 
 
36
 
Each ramp has its own settings -- floor (lowest level), ceiling (highest 
37
 
level), and the stepped ramp can also have a configurable number of 
38
 
steps.
39
 
 
40
 
There are four ways to access this mode when the light is off:
41
 
 
42
 
  - Click: Turn on at the memorized brightness.
43
 
  - Hold: Turn on at the floor level.  The light should give a very 
44
 
    subtle dark blink when the user can let go of the button to stay at 
45
 
    the floor, or keep holding the button to ramp up.
46
 
  - 2 clicks: Turn on at the ceiling level.
47
 
  - Click, hold: Turn on at the ceiling level, then ramp down.
48
 
 
49
 
While the light is on, a few basic actions are available:
50
 
 
51
 
  - Click: Turn off.
52
 
  - 2 clicks: Go to or from turbo (full power).
53
 
  - Hold: Change brightness (up).  If the button was released less than 
54
 
    a second ago, or if it's already at the ceiling, it goes down 
55
 
    instead.
56
 
  - Click, hold: Change brightness (down).
57
 
  - 3 clicks: Switch to the other ramp.
58
 
  - 4 clicks: Go to ramp config mode.
59
 
  - 5 clicks: Activate manual memory and save the current brightness.
60
 
  - 5 clicks, but hold the last click: Go back to automatic memory.
61
 
 
62
 
The "automatic" vs "manual" memory modes change the level the light goes 
63
 
to with 1 click from off.  In automatic mode, it uses the last 
64
 
brightness the user ramped to.  In manual mode, it uses the brightness 
65
 
the user explicitly saved with 5 clicks.
66
 
 
67
 
 
68
 
Other Modes
69
 
-----------
70
 
 
71
 
Anduril has several other modes too.  To access these, press the button 
72
 
more than 2 times when the light is off:
73
 
 
74
 
  - 3 clicks: Access the blinky / utility modes.
75
 
  - Click, click, hold: Access the strobe modes.
76
 
  - 4 clicks: Lockout mode.
77
 
  - 5 clicks: Momentary mode.
78
 
  - 6 clicks: Muggle mode.
79
 
 
80
 
 
81
 
Blinky / Utility Modes
82
 
----------------------
83
 
 
84
 
Click 3 times from Off to access Anduril's blinky / utility modes.  This 
85
 
always starts at battery check and the user can proceed to other blinky 
86
 
modes from there.  The sequence is:
87
 
 
88
 
  1. Battery check.
89
 
  2. Sunset mode.
90
 
  3. Beacon mode.
91
 
  4. Temperature check.
92
 
 
93
 
In all of these modes, some basic actions are available:
94
 
 
95
 
  - Click: Turn off.
96
 
  - 2 clicks: Next blinky mode.
97
 
 
98
 
Additionally, in beacon and temperature check modes:
99
 
 
100
 
  - 4 clicks: Go to the beacon config mode or thermal config mode.
101
 
 
102
 
In more detail, this is what each blinky / utility mode does:
103
 
 
104
 
  1. Battery check.
105
 
 
106
 
     Blinks out the battery voltage per cell.  Full is 4.2V, empty is 
107
 
     about 3.0V.  The light blinks the whole-number digit first, pauses, 
108
 
     then blinks out the "tenths" digit.  Then a longer pause, and it 
109
 
     repeats.
110
 
     So for 4.2V, it would be "blink-blink-blink-blink .. blink-blink".
111
 
 
112
 
     A "zero" digit is represented by a very quick blink.
113
 
 
114
 
  2. Sunset mode.
115
 
 
116
 
     This starts at a low level, then dims gradually for an hour, and 
117
 
     then shuts off.  It is intended for use when going to bed.
118
 
 
119
 
  3. Beacon mode.
120
 
 
121
 
     Blinks at a slow speed.  The light stays on for half a second, and 
122
 
     then stays off until the next blink.  The brightness and the number 
123
 
     of seconds between pulses are configurable:
124
 
 
125
 
       - Brightness is the user's last-ramped level, so set this in 
126
 
         ramping mode before starting beacon mode.
127
 
 
128
 
       - Speed is configured in beacon config mode.  Click 4 times to 
129
 
         enter beacon config mode, wait for the light to stutter, then 
130
 
         click to enter the number of seconds per blink.  For example, 
131
 
         to do a 10-second alpine beacon, click 10 times.
132
 
 
133
 
  4. Temperature check.
134
 
 
135
 
     Blinks out the current temperature in degrees C.  This number 
136
 
     should be pretty close to what a real thermometer says.  If not, it 
137
 
     would be a good idea to click 4 times to enter thermal config mode, 
138
 
     and calibrate the sensor.
139
 
 
140
 
     Thermal config mode has two settings:
141
 
 
142
 
     - Current temperature.  Click once per degree C to calibrate the 
143
 
       sensor.  For example, if the ambient temperature is 21 C, then 
144
 
       click 21 times.
145
 
 
146
 
     - Temperature limit.  This sets the maximum temperature the light 
147
 
       can reach before it will start doing thermal regulation to keep 
148
 
       itself from overheating.  Click once per degree C above 30.  For 
149
 
       example, to set the limit to 50 C, click 20 times.  The default 
150
 
       is 45 C, and the highest value it will allow is 70 C.
151
 
 
152
 
 
153
 
Strobe / Mood Modes
154
 
-------------------
155
 
 
156
 
Anduril includes a few extra modes for a variety of purposes:
157
 
 
158
 
  - Candle mode
159
 
  - Bike flasher
160
 
  - Party strobe
161
 
  - Tactical strobe
162
 
  - Lightning storm mode
163
 
 
164
 
Click 3 times from Off to access these, but hold the third click for a 
165
 
moment.  Click, click, hold.  The last-used strobe mode is remembered, 
166
 
so it will return to whichever one you used last.
167
 
 
168
 
In all of these modes, a few actions are available:
169
 
 
170
 
  - Click: Turn off.
171
 
  - 2 Clicks: Next strobe / mood mode.
172
 
  - Hold: Increase brightness, or strobe faster.  (except lightning)
173
 
  - Click, hold: Decrease brightness, or strobe slower.  (except lightning)
174
 
 
175
 
Additionally, candle mode has one more action:
176
 
 
177
 
  - 3 clicks: Add 30 minutes to the timer.
178
 
 
179
 
In more detail, here is what each mode does:
180
 
 
181
 
  - Candle mode
182
 
 
183
 
    Brightness changes randomly in a pattern resembling a candle flame.  
184
 
    If a timer is set, it will run until the timer expires, then get 
185
 
    dimmer for one minute, then sputter and turn itself off.  Without a 
186
 
    timer, candle mode runs until the user turns it off.  Brightness is 
187
 
    configurable.
188
 
 
189
 
  - Bike flasher
190
 
 
191
 
    Runs at a medium level, but stutters to a brighter level once per 
192
 
    second.  Designed to be more visible than a normal ramping mode, but 
193
 
    otherwise works mostly the same.  Brightness is configurable.
194
 
 
195
 
  - Party strobe
196
 
 
197
 
    Motion-freezing strobe light.  Can be used to freeze spinning fans 
198
 
    and falling water.  Speed is configurable.
199
 
 
200
 
  - Tactical strobe
201
 
 
202
 
    Disorienting strobe light.  Can be used to irritate people.  Speed 
203
 
    is configurable, and the duty cycle is always 33%.
204
 
 
205
 
  - Lightning storm mode
206
 
 
207
 
    Flashes at random brightness and random speed to simulate lightning 
208
 
    strikes during a busy lightning storm.  Do not look directly at the 
209
 
    flashlight when this mode is running, because it may suddenly go to 
210
 
    full power without warning.
211
 
 
212
 
 
213
 
Lockout Mode
214
 
------------
215
 
 
216
 
Click 4 times from Off to enter Lockout mode.  This makes the light safe 
217
 
to carry in a pocket or a bag or anywhere else the button might be 
218
 
pressed by accident.
219
 
 
220
 
To exit lockout mode, click 4 times.  The light should blink briefly and 
221
 
then return to the regular "off" mode.
222
 
 
223
 
Lockout mode also doubles as a momentary moon mode, so the user can do 
224
 
quick tasks without having to unlock the light.  The brightness in 
225
 
lockout mode has two levels:
226
 
 
227
 
  - Hold: light up at the floor level of the current ramp.
228
 
  - Click, Hold: light up at the floor level of the other ramp.
229
 
 
230
 
 
231
 
Momentary Mode
232
 
--------------
233
 
 
234
 
Click 5 times from Off to enter Momentary mode.  This locks the 
235
 
flashlight into a single-mode interface where the LEDs are only on when 
236
 
the button is held down.  It is intended for Morse code, light painting, 
237
 
and other tasks where the light should be on only for a short time and 
238
 
probably in a pattern.
239
 
 
240
 
Momentary mode does either a steady brightness level or a strobe.  To 
241
 
select which one, go to the mode you want to use, adjust the brightness 
242
 
and speed and other settings, then turn the light off.  Then click 5 
243
 
times to enter momentary mode.
244
 
 
245
 
Supported momentary modes are steady (normal ramping mode) and strobes 
246
 
(everything in the "strobe" mode group).
247
 
 
248
 
In steady mode, brightness is the last-ramped level, so adjust that 
249
 
before entering momentary mode.
250
 
 
251
 
In momentary strobe mode, the settings are copied from the last-used 
252
 
strobe mode, such as party strobe, tactical strobe, or lightning.
253
 
 
254
 
To exit this mode, physically disconnect power by unscrewing the tailcap 
255
 
or battery tube.
256
 
 
257
 
 
258
 
Muggle Mode
259
 
-----------
260
 
 
261
 
Click 6 times from Off to enter Muggle mode.  This is a simpler and 
262
 
less-bright interface which makes the light relatively safe to lend to 
263
 
children or other people who could use the light unsafely.
264
 
 
265
 
In Muggle mode, there are only a few available actions:
266
 
 
267
 
  - Click: Turn the light on or off.
268
 
  - Hold: Change brightness.
269
 
  - 6 clicks: Exit Muggle mode.
270
 
 
271
 
The brightness in this mode usually goes from about 10 lm to 300 lm.
272
 
 
273
 
Muggle mode is remembered even after changing the battery.  This helps 
274
 
prevent children from exiting the mode by unscrewing the tailcap.  
275
 
However, be sure to supervise children whenever they are using any 
276
 
powerful tools, including a bright flashlight.
277
 
 
278
 
Note: If the light steps down in muggle mode, it probably needs to have 
279
 
the temperature sensor calibrated.  Use thermal config mode to do this.
280
 
 
281
 
 
282
 
Configuration Modes
283
 
-------------------
284
 
 
285
 
Every config mode has the same interface.  The menu has one or more 
286
 
options the user can configure, and it will go through them in order.  
287
 
For each menu item, the light will follow the same pattern:
288
 
 
289
 
  - Blink one or more times, corresponding to the item number.
290
 
 
291
 
  - Stutter or "buzz" quickly between two brightness levels for a few 
292
 
    seconds.  This indicates that the user can click one or more times 
293
 
    to enter a number.  It will keep buzzing until the user stops 
294
 
    clicking, so there is no need to hurry.
295
 
 
296
 
  - Pause, and then go to the next option.
297
 
 
298
 
After the light has gone through all of the menu options, it should 
299
 
return to whatever mode the light was in before entering the config 
300
 
mode.
301
 
 
302
 
If the user doesn't press a button during a menu item's "buzz" phase, 
303
 
that item remains unchanged from its previous value.
304
 
 
305
 
 
306
 
Ramp Config Mode
307
 
----------------
308
 
 
309
 
While the light is on in a ramping mode, click 4 times to enter the 
310
 
config mode for the current ramp.
311
 
 
312
 
For smooth ramping mode, there are two menu options:
313
 
 
314
 
  1. Floor.  (default = 1/150)
315
 
  2. Ceiling.  (default = 120/150)
316
 
 
317
 
For the stepped ramping mode, there are three menu options:
318
 
 
319
 
  1. Floor.  (default = 20/150)
320
 
  2. Ceiling.  (default = 120/150)
321
 
  3. Number of steps.  (default = 7)
322
 
 
323
 
To configure the floor level, click the button equal to the number of 
324
 
ramp levels (out of 150) at which the floor should be.  To set the 
325
 
lowest possible level, click once.
326
 
 
327
 
To configure the ceiling level, each click goes one level lower.  So 1 
328
 
click sets the highest possible level, 2 clicks is the 2nd-highest, 3 
329
 
clicks is the 3rd-highest level, etc.  To set the default of 120/150, 
330
 
click 31 times.
331
 
 
332
 
When configuring the number of steps, the value can be anything from 2 
333
 
to 150.
334
 
 
335
 
 
336
 
Protection Features
337
 
-------------------
338
 
 
339
 
Anduril includes low voltage protection (LVP) and thermal regulation.
340
 
 
341
 
LVP makes the light step down to a lower level when the battery is low, 
342
 
and if the light is already at the lowest level, it shuts itself off.  
343
 
This activates at 2.8V.  LVP adjustments happen suddenly, in large 
344
 
steps.
345
 
 
346
 
Thermal regulation attempts to keep the light from overheating, and 
347
 
otherwise adjusts output to stay as close as possible to the 
348
 
user-configured temperature limit.  Thermal adjustments happen 
349
 
gradually, in steps so small they are difficult for humans to perceive.
350
 
 
351
 
 
352
 
Aux LEDs / Button LEDs
353
 
----------------------
354
 
 
355
 
Some lights have aux LEDs or button LEDs.  These can be configured to do 
356
 
different things while the main emitters are off.  There is one aux LED 
357
 
mode for the regular "off" mode, and another aux LED mode for "lockout" 
358
 
mode.  This allows the user to see at a glance whether the light is 
359
 
locked.
360
 
 
361
 
Aux LED modes typically include:
362
 
 
363
 
  - Off
364
 
  - Low
365
 
  - High
366
 
  - Blinking
367
 
 
368
 
To configure the aux LEDs, go to the mode you want to configure and then 
369
 
click the button a few times:
370
 
 
371
 
  - Off mode: 7 clicks.
372
 
  - Lockout mode: 3 clicks.
373
 
 
374
 
This should change the aux LEDs to the next mode supported on this 
375
 
light.
376
 
 
377
 
If the aux LEDs can change color, there are additional actions to change 
378
 
the color.  It is the same as above, but hold the button on the last 
379
 
click and then let go when the desired color is reached.
380
 
 
381
 
  - Off mode: 7 clicks, but hold the last click.
382
 
  - Lockout mode: 3 clicks, but hold the last click.
383
 
 
384
 
For lights with a button LED, the button LED typically stays on while 
385
 
the main emitters are on.  Its brightness level is set in a way which 
386
 
mirrors the main LED -- off, low, or high.
387
 
 
388
 
For lights with front-facing aux LEDs, the aux LEDs typically stay off 
389
 
when the main emitters are on, and when the light is otherwise awake.  
390
 
The aux LEDs on most lights only turn on when the light is asleep.