~toykeeper/flashlight-firmware/trunk

85 by Selene Scriven
Added documentation for this collection of firmwares and the interface for each.
1
These firmwares are derived from JonnyC's dual_pwm/STAR_momentary firmware,
2
and are intended for use on ATTINY13A-based drivers with an electronic /
3
momentary switch.  Testing and development was done on a Ferrero Rocher DD
4
driver built by Comfychair of BLF.  This driver has red and green indicator
5
LEDs which are used to indicate approximate battery voltage, but that can be
6
disabled at compile time for use on other drivers.
7
8
http://budgetlightforum.com/node/30673
9
10
Three different interfaces are provided:
11
12
  - Ferrero_Rocher: Similar to STAR_momentary, but with enhancements.
13
14
  - Ramping_UI_table: Smooth ramping UI.
15
16
  - Baton: Stepped ramping UI.
17
18
The interfaces are described in the .txt files for each.
19
20
The red/green indicators are calibrated for the following:
21
22
  - Green:  Battery is at 3.6V or more.
23
  - Yellow: Battery is at 3.3V to 3.6V.
24
  - Red:    Battery is below 3.3V.
25
26
The light may flicker between two colors when voltage is near a threshold.  In
27
particular, it has a tendency to flicker between green and yellow in the 3.6V
28
to 3.9V range, especially if using phase-correct PWM instead of fast PWM.
29
Flickering will be reduced with the "LOWPASS_VOLTAGE" option enabled, or
30
increased with that option disabled.  This is a matter of personal preference,
31
since the flickering can be used to get a better idea what the exact voltage
32
is, instead of using the coarse voltage ranges listed above.
33
34
Additionally, each time the light powers up, the main emitter should blink once
35
very briefly to let you know the batteries are connected.  This can be disabled
36
at compile time.