~toykeeper/flashlight-firmware/trunk

« back to all changes in this revision

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

  • Committer: Selene Scriven
  • Date: 2015-03-17 08:56:50 UTC
  • mto: This revision was merged to the branch mainline in revision 124.
  • Revision ID: ubuntu@toykeeper.net-20150317085650-s89wr9h28n2co7z1
Added TheStar firmwares from _the_

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
From off:
2
 
 
3
 
  Ramp shortcuts:
4
 
  * 1 click: memorized level
5
 
  * Hold: lowest level then ramp up
6
 
  * 2 clicks: highest ramp level
7
 
  * Click, hold: highest level then ramp down
8
 
 
9
 
  Blinkies:
10
 
  * 3 clicks: specials (battcheck, goodnight, beacon, tempcheck)
11
 
  * Click, click, hold: strobes
12
 
    (candle mode, bike flasher, party strobe, tactical strobe,
13
 
     lightning storm mode)
14
 
    (remembers which you last used)
15
 
 
16
 
  Other:
17
 
  * 4 clicks: lock-out
18
 
  * 5 clicks: momentary mode (disconnect power to exit)
19
 
  * 6 clicks: muggle mode
20
 
  * On hardware with an indicator LED...
21
 
    * 7 clicks: Change aux LED mode used in "off" mode.
22
 
                (the modes are usually off/low/high/blinking)
23
 
    * 7 clicks (but hold the last click):
24
 
        Change aux LED color used in "off" mode.
25
 
 
26
 
In steady / ramping mode:
27
 
  * 1 click: off
28
 
  * Hold: ramp up
29
 
  * Click, hold: ramp down
30
 
  * 2 clicks: to/from turbo (actual turbo, not just highest ramp level)
31
 
  * 3 clicks: toggle smooth vs discrete ramping
32
 
  * 4 clicks: configure current ramp
33
 
  * 5 clicks: activate manual memory and save current brightness
34
 
  * 5 clicks (but hold the last click): go back to automatic memory
35
 
 
36
 
Smooth ramp config mode:
37
 
  * Setting 1: low end
38
 
    (click N times to set ramp floor to level N)
39
 
  * Setting 2: high end
40
 
    (click N times to set ramp ceiling to level "151 - N")
41
 
 
42
 
Discrete ramp config mode:
43
 
  * Setting 1: low end
44
 
    (click N times to set ramp floor to level N)
45
 
  * Setting 2: high end
46
 
    (click N times to set ramp ceiling to level "151 - N")
47
 
  * Setting 3: number of levels in discrete ramp
48
 
    (click N times to make discrete mode have N stair-steps)
49
 
    (minimum 2, maximum 150)
50
 
 
51
 
"Strobe" group modes:
52
 
 
53
 
  Candle mode:
54
 
    * 1 click: off
55
 
    * 2 clicks: next "strobe" group mode
56
 
    * 3 clicks: add 30 minutes to the timer
57
 
                (light will shut off when timer expires)
58
 
                (default is no timer)
59
 
    * Hold: brighter
60
 
    * Click, hold: dimmer
61
 
 
62
 
  Bike flasher:
63
 
    * 1 click: off
64
 
    * 2 clicks: next "strobe" group mode
65
 
    * Hold: brighter
66
 
    * Click, hold: dimmer
67
 
 
68
 
  Party / Tactical strobe modes:
69
 
    * 1 click: off
70
 
    * Hold: change speed (faster)
71
 
    * Click, hold: change speed (slower)
72
 
    * 2 clicks: next "strobe" group mode
73
 
      (TODO: random/police strobe?)
74
 
 
75
 
  Lightning storm mode:
76
 
    * 1 click: off
77
 
    * 2 clicks: next "strobe" group mode
78
 
 
79
 
"Blinky" group modes:
80
 
 
81
 
  Battcheck mode:
82
 
    * 1 click: off
83
 
    * 2 clicks: goodnight mode
84
 
 
85
 
  Goodnight mode:
86
 
    * 1 click: off
87
 
    * 2 clicks: beacon mode
88
 
 
89
 
  Beacon mode:
90
 
    * 1 click: off
91
 
    * 2 clicks: tempcheck mode
92
 
    * 4 clicks: configure time between pulses
93
 
 
94
 
    Beacon config mode:
95
 
      * At buzz, click N times to set beacon frequency to N seconds.
96
 
 
97
 
  Tempcheck mode:
98
 
    * 1 click: off
99
 
    * 2 clicks: battcheck mode
100
 
    * 4 clicks: thermal config mode
101
 
 
102
 
    Thermal config mode:
103
 
      * Setting 1: calibrate sensor:
104
 
        At buzz, click N times for N degrees C.  For example, if the light 
105
 
        is current at "room temperature" of 22 C, click 22 times.  Is 
106
 
        intended to only be done once upon initial setup, or not at all.
107
 
      * Setting 2: temperature limit:
108
 
        At buzz, click N times to set thermal limit to roughly 30 C + N.
109
 
 
110
 
Lockout mode:
111
 
  * Hold: momentary moon (current ramp floor)
112
 
  * Click, Hold: momentary moon (other ramp floor)
113
 
  * 4 clicks: exit lockout (return to regular "off" mode)
114
 
  * On hardware with an indicator LED...
115
 
    * 3 clicks: Change aux LED brightness used in lockout mode.
116
 
                (the modes are usually off/low/high/blinking)
117
 
    * 3 clicks (but hold the last click):
118
 
        Change aux LED color used in lockout mode.
119
 
 
120
 
Momentary mode:
121
 
  * Press button: Light on (at memorized mode/level).
122
 
    (uses either a steady mode or a strobe-group mode)
123
 
  * Release button: Light off.
124
 
  * To exit, disconnect power.  (loosen/tighten the tailcap)
125
 
 
126
 
Muggle mode:
127
 
  * 1 click: On / off.
128
 
  * Hold: Ramp up / down.
129
 
  * 6 clicks: Exit muggle mode.
130
 
 
131
 
Indicator LED / aux LED support:
132
 
 
133
 
  The indicator LED (button LED), if there is one, tracks the brightness 
134
 
  of the main LED(s) during use.  It'll be off, low, or high depending 
135
 
  on whether the main emitter is off, using only the first power 
136
 
  channel, or using a higher level.
137
 
 
138
 
  If front-facing aux LEDs are present, they stay off while the main 
139
 
  light is on.  They only turn on when the main emitters are off.
140
 
 
141
 
  The indicator LED can stay on when the light is in the "off" state or 
142
 
  "lockout" state.  These modes can have different settings, to make it 
143
 
  easier to see which one the light is in.  To configure it:
144
 
 
145
 
    1. Go to the standby mode you want to configure.  This is either 
146
 
       "off" or "lockout".
147
 
    2. In "off" mode, click 7 times to switch to the next aux LED mode.
148
 
       Or in "lockout" mode, click 3 times.
149
 
    3. Repeat step 2 until the desired mode is reached.
150
 
 
151
 
  The available aux LED / indicator LED modes vary depending on the type 
152
 
  of light, but they typically have the following modes:
153
 
 
154
 
    - Off
155
 
    - Low
156
 
    - High
157
 
    - Blinking
158
 
 
159
 
  If the aux LEDs can change color, the user can configure the color 
160
 
  using exactly the same method...  except hold the last click until the 
161
 
  desired color is reached.
162
 
 
163
 
 
164
 
TODO:
165
 
  - change 6C to 6H for exiting muggle mode?
166
 
  - move muggle mode from 6C to ... 8C or something?
167
 
  - add 4H from lockout to turn light on and start ramping up?
168
 
  - move config modes to 5C instead of 4C, and move manual memory to 4C?
169
 
  - remove beacon config mode, and use a hold to set timing instead?
170
 
  - rewrite muggle mode to split it into on and off states
171
 
  * save settings in eeprom
172
 
  * decide on "hold until hot" or "click N times" for thermal config mode
173
 
  * test thermal regulation on an actual light
174
 
  * improve thermal regulation
175
 
  - a way to blink out the firmware version?
176
 
  * indicator LED support
177
 
  * a way to configure indicator LED behavior
178
 
    * Go to lockout mode, then click three times.  Hold the third click 
179
 
      to change regular "off" brightness, or make it a fast click to 
180
 
      change lockout mode brightness.
181
 
  * add goodnight mode?
182
 
  * add lightning mode?
183
 
  * muggle mode: smooth ramp
184
 
  * refactor to make config modes smaller
185
 
  * move all config menus to four clicks
186
 
  * candle mode timer, with three clicks to add 30 minutes
187
 
  * diagram updates for 3-click special actions
188
 
  * add a toggle for memory (manual vs automatic memory)
189
 
  - candle mode: smoother adjustments?
190
 
  - make sunset mode timer and brightness configurable?
191
 
  - make beacon mode actually sleep between pulses