22
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
25
 
/******************************************************************************
 
29
 
 * a PC fan is wired up to a 12V power supply
 
31
 
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
 
34
 
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
 
35
 
   LED on pin 4 is in the centre of the clock face and the LED on pin
 
38
 
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
 
39
 
   used to indirectly drive a transistor which in turn drives several
 
40
 
   LEDs that turn on and off in unison in the centre of the clock.
 
42
 
 * a button should be attached to pin 3 that grounds it when pressed.
 
44
 
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
 
46
 
Implementation details:
 
48
 
 * for a schematic, see ../project/propeller-clock.sch.
 
50
 
 * the timing of the drawing of the clock face is recalculated with
 
51
 
   every rotation of the propeller.
 
53
 
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
 
54
 
   software skips every other one. This means that the clock may
 
55
 
   appear upside-down if started with the propeller in the wrong
 
56
 
   position. You will need to experiment to discover the position that
 
57
 
   the propeller must be in when starting the clock.
 
61
 
 * pressing the button cycles between variations of the current
 
64
 
 * pressing and holding the button for a second cycles between display
 
65
 
   modes (e.g., analogue and digital).
 
67
 
 * pressing and holding the button for 5 seconds enters "time set"
 
68
 
   mode. In this mode, the following applies:
 
69
 
    - the field that is being set flashes
 
70
 
    - pressing the button increments the field currently being set
 
71
 
    - pressing and holding the button for a second cycles through the
 
72
 
      fields that can be set
 
73
 
    - pressing and holding the button for 5 seconds sets the time and
 
76
 
******************************************************************************/
 
82
 
#include "analogue_clock.h"
 
83
 
#include "digital_clock.h"
 
84
 
#include "test_pattern.h"
 
85
 
#include "settings_mode.h"
 
87
 
#include "text_renderer.h"
 
90
24
//_____________________________________________________________________________
 
93
28
// when non-zero, the time (in microseconds) of a new fan pulse that
 
94
29
// has just occurred, which means that segment drawing needs to be
 
96
 
static unsigned long _new_pulse_at = 0;
 
 
31
static unsigned long new_pulse_at = 0;
 
98
33
// the time (in microseconds) when the last fan pulse occurred
 
99
 
static unsigned long _last_pulse_at = 0;
 
 
34
static unsigned long last_pulse_at = 0;
 
101
36
// duration (in microseconds) that a segment should be displayed
 
102
 
static unsigned long _segment_step = 0;
 
 
37
static unsigned long segment_step = 0;
 
104
39
// remainder after divisor and a tally of the remainders for each segment
 
105
 
static unsigned long _segment_step_sub_step = 0;
 
106
 
static unsigned long _segment_step_sub = 0;
 
109
 
static Button _button( 3 );
 
112
 
static int _major_mode = 0;
 
113
 
static int _minor_mode = 0;
 
115
 
#define MAIN_MODE_IDX 1
 
116
 
#define SETTINGS_MODE_IDX 0
 
118
 
#define ANALOGUE_CLOCK_IDX 0
 
119
 
#define DIGITAL_CLOCK_IDX 1
 
120
 
#define TEST_PATTERN_IDX 2
 
 
40
static unsigned long segment_step_sub_step = 0;
 
 
41
static unsigned long segment_step_sub = 0;
 
122
47
//_____________________________________________________________________________
 
126
 
// activate the current minor mode
 
127
 
void activate_minor_mode()
 
129
 
        switch( _minor_mode ) {
 
130
 
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
 
131
 
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
140
 
// activate major mode
 
141
 
void activate_major_mode()
 
143
 
        switch( _major_mode ) {
 
144
 
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
145
 
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
 
154
 
// perform button events
 
155
 
void do_button_events()
 
157
 
        // loop through pending events
 
158
 
        while( int event = _button.get_event() )
 
 
51
// ISR to handle the pulses from the fan's tachiometer
 
 
52
void fanPulseHandler()
 
 
54
        // the fan actually sends two pulses per revolution. These pulses
 
 
55
        // may not be exactly evenly distributed around the rotation, so
 
 
56
        // we can't recalculate times on every pulse. Instead, we ignore
 
 
57
        // every other pulse so timings are based on a complete rotation.
 
 
58
        static bool ignore = true;
 
164
 
                        switch( _major_mode ) {
 
166
 
                                switch( _minor_mode ) {
 
167
 
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
168
 
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
171
 
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
 
177
 
                        switch( _major_mode ) {
 
179
 
                                if( ++_minor_mode >= 3 )
 
181
 
                                activate_minor_mode();
 
183
 
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
 
188
 
                        // looooong press (change major mode)
 
189
 
                        if( ++_major_mode > 1 )
 
191
 
                        activate_major_mode();
 
 
62
                // set a new pulse time
 
 
63
                new_pulse_at = micros();
 
198
 
// draw a display segment
 
199
 
void draw_next_segment( bool reset )
 
 
68
// draw a particular segment
 
 
69
void drawNextSegment( bool reset )
 
201
 
        // keep track of segment
 
203
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
204
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
206
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
207
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
210
 
        // reset the text renderer
 
211
 
        TextRenderer::reset_buffer();
 
215
 
                switch( _major_mode ) {
 
217
 
                        switch( _minor_mode ) {
 
218
 
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
219
 
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
222
 
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
 
225
 
                // tell the text services we're starting a new frame
 
230
 
        switch( _major_mode ) {
 
232
 
                switch( _minor_mode ) {
 
233
 
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
234
 
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
235
 
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
238
 
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
 
241
 
        // draw any text that was rendered
 
242
 
        TextRenderer::output_buffer();
 
245
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
247
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
 
71
        static unsigned int segment = 0;
 
 
72
        if( reset ) segment = 0;
 
 
75
        for( int a = 0; a < 10; a++ )
 
 
76
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
252
80
// calculate time constants when a new pulse has occurred
 
253
 
void calculate_segment_times()
 
 
81
void calculateSegmentTimes()
 
255
83
        // check for overflows, and only recalculate times if there isn't
 
256
84
        // one (if there is, we'll just go with the last pulse's times)
 
257
 
        if( _new_pulse_at > _last_pulse_at )
 
 
85
        if( new_pulse_at > last_pulse_at )
 
259
87
                // new segment stepping times
 
260
 
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
261
 
                _segment_step = delta / NUM_SEGMENTS;
 
262
 
                _segment_step_sub = 0;
 
263
 
                _segment_step_sub_step = delta % NUM_SEGMENTS;
 
 
88
                unsigned long delta = new_pulse_at - last_pulse_at;
 
 
89
                segment_step = delta / NUM_SEGMENTS;
 
 
91
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
266
94
        // now we have dealt with this pulse, save the pulse time and
 
267
95
        // clear new_pulse_at, ready for the next pulse
 
268
 
        _last_pulse_at = _new_pulse_at;
 
 
96
        last_pulse_at = new_pulse_at;
 
273
101
// wait until it is time to draw the next segment or a new pulse has
 
275
 
void wait_till_end_of_segment( bool reset )
 
 
103
void waitTillNextSegment( bool reset )
 
277
105
        static unsigned long end_time = 0;
 
281
 
                end_time = _last_pulse_at;
 
 
109
                end_time = last_pulse_at;
 
283
111
        // work out the time that this segment should be displayed until
 
284
 
        end_time += _segment_step;
 
285
 
        _segment_step_sub += _segment_step_sub_step;
 
286
 
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
287
 
                _segment_step_sub -= NUM_SEGMENTS;
 
 
112
        end_time += segment_step;
 
 
113
        semgment_step_sub += semgment_step_sub_step;
 
 
114
        if( semgment_step_sub >= NUM_SEGMENTS ) {
 
 
115
                semgment_step_sub -= NUM_SEGMENTS;
 
292
 
        while( micros() < end_time && !_new_pulse_at );
 
296
 
// ISR to handle the pulses from the fan's tachiometer
 
297
 
void fan_pulse_handler()
 
299
 
        // the fan actually sends two pulses per revolution. These pulses
 
300
 
        // may not be exactly evenly distributed around the rotation, so
 
301
 
        // we can't recalculate times on every pulse. Instead, we ignore
 
302
 
        // every other pulse so timings are based on a complete rotation.
 
303
 
        static bool ignore = true;
 
307
 
                // set a new pulse time
 
308
 
                _new_pulse_at = micros();
 
 
120
        while( micros() < end_time && !new_pulse_at );