/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: Tim Marston
  • Date: 2012-05-09 20:36:07 UTC
  • Revision ID: tim@ed.am-20120509203607-5sh14qikxjmm6p3y
updated arduino.mk

Show diffs side-by-side

added added

removed removed

src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
1
2
/*
2
 
 * propeller-clock.pde
 
3
 * propeller-clock.ino
3
4
 *
4
 
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
 
5
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
6
 *
6
7
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/software/arduino/propeller-clock for more
 
8
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
8
9
 * information.
9
10
 *
10
11
 * This program is free software: you can redistribute it and/or modify
21
22
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23
 */
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
 
24
90
//_____________________________________________________________________________
25
91
//                                                                         data
26
92
 
27
 
 
28
93
// when non-zero, the time (in microseconds) of a new fan pulse that
29
94
// has just occurred, which means that segment drawing needs to be
30
95
// restarted
31
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
32
97
 
33
98
// the time (in microseconds) when the last fan pulse occurred
34
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
35
100
 
36
101
// duration (in microseconds) that a segment should be displayed
37
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
38
103
 
39
104
// remainder after divisor and a tally of the remainders for each segment
40
 
static unsigned long segment_step_sub_step = 0;
41
 
static unsigned long segment_step_sub = 0;
42
 
 
43
 
// number of segments in a full display (rotation) is 60 (one per
44
 
// second) times the desired number of sub-divisions of a second
45
 
#define NUM_SEGMENTS ( 60 * 5 )
46
 
 
 
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
47
121
 
48
122
//_____________________________________________________________________________
49
123
//                                                                         code
50
124
 
51
125
 
52
 
// ISR to handle the pulses from the fan's tachiometer
53
 
void fanPulseHandler()
54
 
{
55
 
        // the fan actually sends two pulses per revolution. These pulses
56
 
        // may not be exactly evenly distributed around the rotation, so
57
 
        // we can't recalculate times on every pulse. Instead, we ignore
58
 
        // every other pulse so timings are based on a complete rotation.
59
 
        static bool ignore = true;
60
 
        ignore = !ignore;
61
 
        if( !ignore )
 
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() )
62
164
        {
63
 
                // set a new pulse time
64
 
                new_pulse_at = micros();
 
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
                }
65
199
        }
66
200
}
67
201
 
68
202
 
69
 
// draw a particular segment
70
 
void drawNextSegment( bool reset )
 
203
// draw a display segment
 
204
void draw_next_segment( bool reset )
71
205
{
72
 
        static unsigned int segment = 0;
73
 
        if( reset ) segment = 0;
74
 
        segment++;
75
 
 
76
 
        for( int a = 0; a < 10; a++ )
77
 
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
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
78
254
}
79
255
 
80
256
 
81
257
// calculate time constants when a new pulse has occurred
82
 
void calculateSegmentTimes()
 
258
void calculate_segment_times()
83
259
{
84
260
        // check for overflows, and only recalculate times if there isn't
85
261
        // one (if there is, we'll just go with the last pulse's times)
86
 
        if( new_pulse_at > last_pulse_at )
 
262
        if( _new_pulse_at > _last_pulse_at )
87
263
        {
88
264
                // new segment stepping times
89
 
                unsigned long delta = new_pulse_at - last_pulse_at;
90
 
                segment_step = delta / NUM_SEGMENTS;
91
 
                segment_step_sub = 0;
92
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
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;
93
269
        }
94
270
 
95
271
        // now we have dealt with this pulse, save the pulse time and
96
272
        // clear new_pulse_at, ready for the next pulse
97
 
        last_pulse_at = new_pulse_at;
98
 
        new_pulse_at = 0;
 
273
        _last_pulse_at = _new_pulse_at;
 
274
        _new_pulse_at = 0;
99
275
}
100
276
 
101
277
 
102
278
// wait until it is time to draw the next segment or a new pulse has
103
279
// occurred
104
 
void waitTillNextSegment( bool reset )
 
280
void wait_till_end_of_segment( bool reset )
105
281
{
106
282
        static unsigned long end_time = 0;
107
283
 
108
284
        // handle reset
109
285
        if( reset )
110
 
                end_time = last_pulse_at;
 
286
                end_time = _last_pulse_at;
111
287
 
112
288
        // work out the time that this segment should be displayed until
113
 
        end_time += segment_step;
114
 
        semgment_step_sub += semgment_step_sub_step;
115
 
        if( semgment_step_sub >= NUM_SEGMENTS ) {
116
 
                semgment_step_sub -= NUM_SEGMENTS;
 
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;
117
293
                end_time++;
118
294
        }
119
295
 
120
296
        // wait
121
 
        while( micros() < end_time && !new_pulse_at );
 
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
        }
122
315
}
123
316
 
124
317
 
126
319
void setup()
127
320
{
128
321
        // set up an interrupt handler on pin 2 to nitice fan pulses
129
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
322
        attachInterrupt( 0, fan_pulse_handler, RISING );
130
323
        digitalWrite( 2, HIGH );
131
324
  
132
325
        // set up output pins (4 to 13) for the led array
133
326
        for( int a = 4; a < 14; a++ )
134
327
                pinMode( a, OUTPUT );
135
328
 
136
 
        // serial comms
137
 
        Serial.begin( 9600 );
 
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();
138
343
}
139
344
 
140
345
 
142
347
void loop()
143
348
{
144
349
        // if there has been a new pulse, we'll be resetting the display
145
 
        bool reset = new_pulse_at? true : false;
 
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
        }
146
368
 
147
369
        // draw this segment
148
 
        drawNextSegment( reset );
149
 
 
150
 
        // do we need to recalculate segment times?
151
 
        if( reset )
152
 
                calculateSegmentTimes();
 
370
        draw_next_segment( reset );
153
371
 
154
372
        // wait till it's time to draw the next segment
155
 
        waitTillNextSegment( reset );
 
373
        wait_till_end_of_segment( reset );
156
374
}