/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: edam
  • Date: 2012-03-20 22:13:38 UTC
  • Revision ID: tim@ed.am-20120320221338-4zvmyesujc0zwwsx
updated arduino makefile

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
        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() )
62
159
        {
63
 
                // set a new pulse time
64
 
                new_pulse_at = micros();
 
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
                }
65
194
        }
66
195
}
67
196
 
68
197
 
69
 
// draw a particular segment
70
 
void drawNextSegment( bool reset )
 
198
// draw a display segment
 
199
void draw_next_segment( bool reset )
71
200
{
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 );
 
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
78
249
}
79
250
 
80
251
 
81
252
// calculate time constants when a new pulse has occurred
82
 
void calculateSegmentTimes()
 
253
void calculate_segment_times()
83
254
{
84
255
        // check for overflows, and only recalculate times if there isn't
85
256
        // one (if there is, we'll just go with the last pulse's times)
86
 
        if( new_pulse_at > last_pulse_at )
 
257
        if( _new_pulse_at > _last_pulse_at )
87
258
        {
88
259
                // 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;
 
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;
93
264
        }
94
265
 
95
266
        // now we have dealt with this pulse, save the pulse time and
96
267
        // clear new_pulse_at, ready for the next pulse
97
 
        last_pulse_at = new_pulse_at;
98
 
        new_pulse_at = 0;
 
268
        _last_pulse_at = _new_pulse_at;
 
269
        _new_pulse_at = 0;
99
270
}
100
271
 
101
272
 
102
273
// wait until it is time to draw the next segment or a new pulse has
103
274
// occurred
104
 
void waitTillNextSegment( bool reset )
 
275
void wait_till_end_of_segment( bool reset )
105
276
{
106
277
        static unsigned long end_time = 0;
107
278
 
108
279
        // handle reset
109
280
        if( reset )
110
 
                end_time = last_pulse_at;
 
281
                end_time = _last_pulse_at;
111
282
 
112
283
        // 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;
 
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;
117
288
                end_time++;
118
289
        }
119
290
 
120
291
        // wait
121
 
        while( micros() < end_time && !new_pulse_at );
 
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
        }
122
310
}
123
311
 
124
312
 
126
314
void setup()
127
315
{
128
316
        // set up an interrupt handler on pin 2 to nitice fan pulses
129
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
317
        attachInterrupt( 0, fan_pulse_handler, RISING );
130
318
        digitalWrite( 2, HIGH );
131
319
  
132
320
        // set up output pins (4 to 13) for the led array
133
321
        for( int a = 4; a < 14; a++ )
134
322
                pinMode( a, OUTPUT );
135
323
 
136
 
        // serial comms
137
 
        Serial.begin( 9600 );
 
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();
138
335
}
139
336
 
140
337
 
142
339
void loop()
143
340
{
144
341
        // if there has been a new pulse, we'll be resetting the display
145
 
        bool reset = new_pulse_at? true : false;
 
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
        }
146
360
 
147
361
        // draw this segment
148
 
        drawNextSegment( reset );
149
 
 
150
 
        // do we need to recalculate segment times?
151
 
        if( reset )
152
 
                calculateSegmentTimes();
 
362
        draw_next_segment( reset );
153
363
 
154
364
        // wait till it's time to draw the next segment
155
 
        waitTillNextSegment( reset );
 
365
        wait_till_end_of_segment( reset );
156
366
}