~toykeeper/flashlight-firmware/trunk

85 by Selene Scriven
Added documentation for this collection of firmwares and the interface for each.
1
This UI implements smooth ramping.  The interface is:
2
3
From off:
4
5
  - Short press to access the last-used mode.
6
  - Long press to enter moon mode and optionally start ramping.
7
  - Double click for the highest mode.
8
9
While on:
10
11
  - Short press to turn off.
12
  - Long press and hold to ramp brightness up or down.  Stops at the 
13
    highest and lowest levels, and auto-reverses when appropriate.
14
  - After releasing a ramp action, ramp again within 1 second to reverse 
15
    the ramp direction.  This way if you go too far, just release and 
16
    ramp again to go back to where you intended to stop.
17
  - (TODO) Double click for a blinky mode (beacon?).
18
19
Low-voltage protection is enabled by default, but turbo step-down is 
20
not.  Change the compile-time options if you want turbo (there isn't 
21
enough room for it with the default options).
22
23
If you enable PFM (pulse frequency modulation), the ramp should be 
24
smoother at the lowest levels.  Otherwise, the lowest levels will ramp 
25
in a stair-step pattern.