/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/propeller-clock.cc

  • Committer: Dan
  • Date: 2011-11-16 19:12:01 UTC
  • Revision ID: dan@waxworlds.org-20111116191201-g6llzg503hmi35uu
Added fantest project

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.cc
1
 
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
 
/*
3
 
 * propeller-clock.ino
4
 
 *
5
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
6
 
 *
7
 
 * This file is part of propeller-clock (hereafter referred to as "this
8
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
9
 
 * information.
10
 
 *
11
 
 * This program is free software: you can redistribute it and/or modify
12
 
 * it under the terms of the GNU Lesser General Public License as published
13
 
 * by the Free Software Foundation, either version 3 of the License, or
14
 
 * (at your option) any later version.
15
 
 *
16
 
 * This program is distributed in the hope that it will be useful,
17
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
 
 * GNU Lesser General Public License for more details.
20
 
 *
21
 
 * You should have received a copy of the GNU Lesser General Public License
22
 
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23
 
 */
24
 
 
25
 
/******************************************************************************
26
 
 
27
 
Set up:
28
 
 
29
 
 * a PC fan is wired up to a 12V power supply
30
 
 
31
 
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
32
 
   Arduino.
33
 
 
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
36
 
   13 is at the outside.
37
 
 
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.
41
 
 
42
 
 * a button should be attached to pin 3 that grounds it when pressed.
43
 
 
44
 
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
45
 
 
46
 
Implementation details:
47
 
 
48
 
 * for a schematic, see ../project/propeller-clock.sch.
49
 
 
50
 
 * the timing of the drawing of the clock face is recalculated with
51
 
   every rotation of the propeller.
52
 
    
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.
58
 
    
59
 
Usage instructions:
60
 
 
61
 
 * pressing the button cycles between variations of the current
62
 
   display mode.
63
 
  
64
 
 * pressing and holding the button for a second cycles between display
65
 
   modes (e.g., analogue and digital).
66
 
 
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
74
 
      exits "time set" mode
75
 
 
76
 
******************************************************************************/
77
 
 
78
 
#include "config.h"
79
 
#include "button.h"
80
 
#include "time.h"
81
 
#include "Arduino.h"
82
 
#include "modes/analogue_clock.h"
83
 
#include "modes/digital_clock.h"
84
 
#include "modes/test_pattern.h"
85
 
#include "modes/settings_mode.h"
86
 
#include "text.h"
87
 
#include "text_renderer.h"
88
 
#include "common.h"
89
 
 
90
 
//_____________________________________________________________________________
91
 
//                                                                         data
92
 
 
93
 
// when non-zero, the time (in microseconds) of a new fan pulse that
94
 
// has just occurred, which means that segment drawing needs to be
95
 
// restarted
96
 
static unsigned long _new_pulse_at = 0;
97
 
 
98
 
// the time (in microseconds) when the last fan pulse occurred
99
 
static unsigned long _last_pulse_at = 0;
100
 
 
101
 
// duration (in microseconds) that a segment should be displayed
102
 
static unsigned long _segment_step = 0;
103
 
 
104
 
// 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;
107
 
 
108
 
// the button
109
 
static Button _button( 3 );
110
 
 
111
 
// modes
112
 
static int _major_mode = 0;
113
 
static int _minor_mode = 0;
114
 
 
115
 
#define MAIN_MODE_IDX 1
116
 
#define SETTINGS_MODE_IDX 0
117
 
 
118
 
#define ANALOGUE_CLOCK_IDX 0
119
 
#define DIGITAL_CLOCK_IDX 1
120
 
#define TEST_PATTERN_IDX 2
121
 
 
122
 
//_____________________________________________________________________________
123
 
//                                                                         code
124
 
 
125
 
 
126
 
// activate the current minor mode
127
 
void activate_minor_mode()
128
 
{
129
 
        // reset text
130
 
        Text::reset();
131
 
        leds_off();
132
 
 
133
 
        // give the mode a chance to init
134
 
        switch( _minor_mode ) {
135
 
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
136
 
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
137
 
        }
138
 
}
139
 
 
140
 
 
141
 
// activate major mode
142
 
void activate_major_mode()
143
 
{
144
 
        // reset text
145
 
        Text::reset();
146
 
        leds_off();
147
 
 
148
 
        // reset buttons
149
 
        _button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
150
 
 
151
 
        // give the mode a chance to init
152
 
        switch( _major_mode ) {
153
 
        case MAIN_MODE_IDX: activate_minor_mode(); break;
154
 
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
155
 
        }
156
 
}
157
 
 
158
 
 
159
 
// perform button events
160
 
void do_button_events()
161
 
{
162
 
        // loop through pending events
163
 
        while( int event = _button.get_event() )
164
 
        {
165
 
                switch( event )
166
 
                {
167
 
                case 1:
168
 
                        // short press
169
 
                        switch( _major_mode ) {
170
 
                        case MAIN_MODE_IDX:
171
 
                                switch( _minor_mode ) {
172
 
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
173
 
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
174
 
                                }
175
 
                                break;
176
 
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
177
 
                        }
178
 
                        break;
179
 
 
180
 
                case 2:
181
 
                        // long press
182
 
                        switch( _major_mode ) {
183
 
                        case MAIN_MODE_IDX:
184
 
                                if( ++_minor_mode >= 3 )
185
 
                                        _minor_mode = 0;
186
 
                                activate_minor_mode();
187
 
                                break;
188
 
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
189
 
                        }
190
 
                        break;
191
 
 
192
 
                case 3:
193
 
                        // looooong press (change major mode)
194
 
                        if( ++_major_mode > 1 )
195
 
                                _major_mode = 0;
196
 
                        activate_major_mode();
197
 
                        break;
198
 
                }
199
 
        }
200
 
}
201
 
 
202
 
 
203
 
// draw a display segment
204
 
void draw_next_segment( bool reset )
205
 
{
206
 
        // keep track of segment
207
 
#if CLOCK_FORWARD
208
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
209
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
210
 
#else
211
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
212
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
213
 
#endif
214
 
 
215
 
        // reset the text renderer
216
 
        TextRenderer::reset_buffer();
217
 
 
218
 
        // frame reset
219
 
        if( reset ) {
220
 
                switch( _major_mode ) {
221
 
                case MAIN_MODE_IDX:
222
 
                        switch( _minor_mode ) {
223
 
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
224
 
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
225
 
                        }
226
 
                        break;
227
 
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
228
 
                }
229
 
 
230
 
                // tell the text services we're starting a new frame
231
 
                Text::draw_reset();
232
 
        }
233
 
 
234
 
        // draw
235
 
        switch( _major_mode ) {
236
 
        case MAIN_MODE_IDX:
237
 
                switch( _minor_mode ) {
238
 
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
239
 
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
240
 
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
241
 
                }
242
 
                break;
243
 
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
244
 
        }
245
 
 
246
 
        // draw any text that was rendered
247
 
        TextRenderer::output_buffer();
248
 
 
249
 
#if CLOCK_FORWARD
250
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
251
 
#else
252
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
253
 
#endif
254
 
}
255
 
 
256
 
 
257
 
// calculate time constants when a new pulse has occurred
258
 
void calculate_segment_times()
259
 
{
260
 
        // check for overflows, and only recalculate times if there isn't
261
 
        // one (if there is, we'll just go with the last pulse's times)
262
 
        if( _new_pulse_at > _last_pulse_at )
263
 
        {
264
 
                // new segment stepping times
265
 
                unsigned long delta = _new_pulse_at - _last_pulse_at;
266
 
                _segment_step = delta / NUM_SEGMENTS;
267
 
                _segment_step_sub = 0;
268
 
                _segment_step_sub_step = delta % NUM_SEGMENTS;
269
 
        }
270
 
 
271
 
        // now we have dealt with this pulse, save the pulse time and
272
 
        // clear new_pulse_at, ready for the next pulse
273
 
        _last_pulse_at = _new_pulse_at;
274
 
        _new_pulse_at = 0;
275
 
}
276
 
 
277
 
 
278
 
// wait until it is time to draw the next segment or a new pulse has
279
 
// occurred
280
 
void wait_till_end_of_segment( bool reset )
281
 
{
282
 
        static unsigned long end_time = 0;
283
 
 
284
 
        // handle reset
285
 
        if( reset )
286
 
                end_time = _last_pulse_at;
287
 
 
288
 
        // work out the time that this segment should be displayed until
289
 
        end_time += _segment_step;
290
 
        _segment_step_sub += _segment_step_sub_step;
291
 
        if( _segment_step_sub >= NUM_SEGMENTS ) {
292
 
                _segment_step_sub -= NUM_SEGMENTS;
293
 
                end_time++;
294
 
        }
295
 
 
296
 
        // wait
297
 
        while( micros() < end_time && !_new_pulse_at );
298
 
}
299
 
 
300
 
 
301
 
// ISR to handle the pulses from the fan's tachiometer
302
 
void fan_pulse_handler()
303
 
{
304
 
        // the fan actually sends two pulses per revolution. These pulses
305
 
        // may not be exactly evenly distributed around the rotation, so
306
 
        // we can't recalculate times on every pulse. Instead, we ignore
307
 
        // every other pulse so timings are based on a complete rotation.
308
 
        static bool ignore = true;
309
 
        ignore = !ignore;
310
 
        if( !ignore )
311
 
        {
312
 
                // set a new pulse time
313
 
                _new_pulse_at = micros();
314
 
        }
315
 
}
316
 
 
317
 
 
318
 
// main setup
319
 
void setup()
320
 
{
321
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
322
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
323
 
        digitalWrite( 2, HIGH );
324
 
  
325
 
        // set up output pins (4 to 13) for the led array
326
 
        for( int a = 4; a < 14; a++ )
327
 
                pinMode( a, OUTPUT );
328
 
 
329
 
        // set up mode-switch button on pin 3
330
 
        pinMode( 3, INPUT );
331
 
        digitalWrite( 3, HIGH );
332
 
        static int event_times[] = { 5, 500, 4000, 0 };
333
 
        _button.set_event_times( event_times );
334
 
 
335
 
        // initialise RTC
336
 
        Time::init();
337
 
 
338
 
        // init text renderer
339
 
        TextRenderer::init();
340
 
 
341
 
        // activate the minor mode
342
 
        activate_major_mode();
343
 
}
344
 
 
345
 
 
346
 
// main loop
347
 
void loop()
348
 
{
349
 
        // if there has been a new pulse, we'll be resetting the display
350
 
        bool reset = _new_pulse_at? true : false;
351
 
 
352
 
        // update button
353
 
        _button.update();
354
 
 
355
 
        // only do this stuff at the start of a display cycle, to ensure
356
 
        // that no state changes mid-display
357
 
        if( reset )
358
 
        {
359
 
                // calculate segment times
360
 
                calculate_segment_times();
361
 
 
362
 
                // keep track of time
363
 
                Time::update();
364
 
 
365
 
                // perform button events
366
 
                do_button_events();
367
 
        }
368
 
 
369
 
        // draw this segment
370
 
        draw_next_segment( reset );
371
 
 
372
 
        // wait till it's time to draw the next segment
373
 
        wait_till_end_of_segment( reset );
374
 
}