/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-03 00:54:13 UTC
  • Revision ID: dan@waxworlds.org-20111103005413-miheyjsrpm3a0r1e
modified notes

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 "analogue_clock.h"
83
 
#include "digital_clock.h"
84
 
#include "test_pattern.h"
85
 
#include "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
 
        switch( _minor_mode ) {
130
 
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
131
 
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
132
 
        }
133
 
 
134
 
        // reset text
135
 
        Text::reset();
136
 
        leds_off();
137
 
}
138
 
 
139
 
 
140
 
// activate major mode
141
 
void activate_major_mode()
142
 
{
143
 
        switch( _major_mode ) {
144
 
        case MAIN_MODE_IDX: activate_minor_mode(); break;
145
 
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
146
 
        }
147
 
 
148
 
        // reset text
149
 
        Text::reset();
150
 
        leds_off();
151
 
}
152
 
 
153
 
 
154
 
// perform button events
155
 
void do_button_events()
156
 
{
157
 
        // loop through pending events
158
 
        while( int event = _button.get_event() )
159
 
        {
160
 
                switch( event )
161
 
                {
162
 
                case 1:
163
 
                        // short press
164
 
                        switch( _major_mode ) {
165
 
                        case MAIN_MODE_IDX:
166
 
                                switch( _minor_mode ) {
167
 
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
168
 
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
169
 
                                }
170
 
                                break;
171
 
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
172
 
                        }
173
 
                        break;
174
 
 
175
 
                case 2:
176
 
                        // long press
177
 
                        switch( _major_mode ) {
178
 
                        case MAIN_MODE_IDX:
179
 
                                if( ++_minor_mode >= 3 )
180
 
                                        _minor_mode = 0;
181
 
                                activate_minor_mode();
182
 
                                break;
183
 
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
184
 
                        }
185
 
                        break;
186
 
 
187
 
                case 3:
188
 
                        // looooong press (change major mode)
189
 
                        if( ++_major_mode > 1 )
190
 
                                _major_mode = 0;
191
 
                        activate_major_mode();
192
 
                        break;
193
 
                }
194
 
        }
195
 
}
196
 
 
197
 
 
198
 
// draw a display segment
199
 
void draw_next_segment( bool reset )
200
 
{
201
 
        // keep track of segment
202
 
#if CLOCK_FORWARD
203
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
204
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
205
 
#else
206
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
207
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
208
 
#endif
209
 
 
210
 
        // reset the text renderer
211
 
        TextRenderer::reset_buffer();
212
 
 
213
 
        // frame reset
214
 
        if( reset ) {
215
 
                switch( _major_mode ) {
216
 
                case MAIN_MODE_IDX:
217
 
                        switch( _minor_mode ) {
218
 
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
219
 
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
220
 
                        }
221
 
                        break;
222
 
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
223
 
                }
224
 
 
225
 
                // tell the text services we're starting a new frame
226
 
                Text::draw_reset();
227
 
        }
228
 
 
229
 
        // draw
230
 
        switch( _major_mode ) {
231
 
        case MAIN_MODE_IDX:
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;
236
 
                }
237
 
                break;
238
 
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
239
 
        }
240
 
 
241
 
        // draw any text that was rendered
242
 
        TextRenderer::output_buffer();
243
 
 
244
 
#if CLOCK_FORWARD
245
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
246
 
#else
247
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
248
 
#endif
249
 
}
250
 
 
251
 
 
252
 
// calculate time constants when a new pulse has occurred
253
 
void calculate_segment_times()
254
 
{
255
 
        // check for overflows, and only recalculate times if there isn't
256
 
        // one (if there is, we'll just go with the last pulse's times)
257
 
        if( _new_pulse_at > _last_pulse_at )
258
 
        {
259
 
                // 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;
264
 
        }
265
 
 
266
 
        // now we have dealt with this pulse, save the pulse time and
267
 
        // clear new_pulse_at, ready for the next pulse
268
 
        _last_pulse_at = _new_pulse_at;
269
 
        _new_pulse_at = 0;
270
 
}
271
 
 
272
 
 
273
 
// wait until it is time to draw the next segment or a new pulse has
274
 
// occurred
275
 
void wait_till_end_of_segment( bool reset )
276
 
{
277
 
        static unsigned long end_time = 0;
278
 
 
279
 
        // handle reset
280
 
        if( reset )
281
 
                end_time = _last_pulse_at;
282
 
 
283
 
        // 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;
288
 
                end_time++;
289
 
        }
290
 
 
291
 
        // wait
292
 
        while( micros() < end_time && !_new_pulse_at );
293
 
}
294
 
 
295
 
 
296
 
// ISR to handle the pulses from the fan's tachiometer
297
 
void fan_pulse_handler()
298
 
{
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;
304
 
        ignore = !ignore;
305
 
        if( !ignore )
306
 
        {
307
 
                // set a new pulse time
308
 
                _new_pulse_at = micros();
309
 
        }
310
 
}
311
 
 
312
 
 
313
 
// main setup
314
 
void setup()
315
 
{
316
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
317
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
318
 
        digitalWrite( 2, HIGH );
319
 
  
320
 
        // set up output pins (4 to 13) for the led array
321
 
        for( int a = 4; a < 14; a++ )
322
 
                pinMode( a, OUTPUT );
323
 
 
324
 
        // set up mode-switch button on pin 3
325
 
        pinMode( 3, INPUT );
326
 
        digitalWrite( 3, HIGH );
327
 
        static int event_times[] = { 5, 500, 4000, 0 };
328
 
        _button.set_event_times( event_times );
329
 
 
330
 
        // initialise RTC
331
 
        Time::init();
332
 
 
333
 
        // activate the minor mode
334
 
        activate_major_mode();
335
 
}
336
 
 
337
 
 
338
 
// main loop
339
 
void loop()
340
 
{
341
 
        // if there has been a new pulse, we'll be resetting the display
342
 
        bool reset = _new_pulse_at? true : false;
343
 
 
344
 
        // update button
345
 
        _button.update();
346
 
 
347
 
        // only do this stuff at the start of a display cycle, to ensure
348
 
        // that no state changes mid-display
349
 
        if( reset )
350
 
        {
351
 
                // calculate segment times
352
 
                calculate_segment_times();
353
 
 
354
 
                // keep track of time
355
 
                Time::update();
356
 
 
357
 
                // perform button events
358
 
                do_button_events();
359
 
        }
360
 
 
361
 
        // draw this segment
362
 
        draw_next_segment( reset );
363
 
 
364
 
        // wait till it's time to draw the next segment
365
 
        wait_till_end_of_segment( reset );
366
 
}