/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-04-29 15:27:19 UTC
  • Revision ID: tim@ed.am-20120429152719-4cu2t9lx7bxpbml1
added adjustable text scaling factor

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
1
2
/*
2
3
 * propeller-clock.ino
3
4
 *
27
28
 
28
29
 * a PC fan is wired up to a 12V power supply
29
30
 
30
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
31
 
   arduino.
 
31
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
 
32
   Arduino.
32
33
 
33
 
 * the pins 4 to 13 on the arduino should directly drive an LED (the
 
34
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
34
35
   LED on pin 4 is in the centre of the clock face and the LED on pin
35
36
   13 is at the outside.
36
37
 
37
38
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
38
 
   used to indirectly drive (via a MOSFET) multiple LEDs which turn on
39
 
   and off in unison in the centre of the clock.
 
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.
40
41
 
41
42
 * a button should be attached to pin 3 that grounds it when pressed.
42
43
 
 
44
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
 
45
 
43
46
Implementation details:
44
47
 
45
 
 * for a schematic, see project/propeller-clock.sch.
 
48
 * for a schematic, see ../project/propeller-clock.sch.
46
49
 
47
50
 * the timing of the drawing of the clock face is recalculated with
48
51
   every rotation of the propeller.
49
52
    
50
 
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
 
53
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
51
54
   software skips every other one. This means that the clock may
52
55
   appear upside-down if started with the propeller in the wrong
53
 
   position. You will need to experiment to dicsover the position that
 
56
   position. You will need to experiment to discover the position that
54
57
   the propeller must be in when starting the clock.
55
58
    
56
59
Usage instructions:
67
70
    - pressing the button increments the field currently being set
68
71
    - pressing and holding the button for a second cycles through the
69
72
      fields that can be set
70
 
    - press and holding the button for 5 seconds to finish
 
73
    - pressing and holding the button for 5 seconds sets the time and
 
74
      exits "time set" mode
71
75
 
72
76
******************************************************************************/
73
77
 
74
 
 
75
 
#include <Bounce.h>
 
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"
76
89
 
77
90
//_____________________________________________________________________________
78
91
//                                                                         data
79
92
 
80
 
 
81
93
// when non-zero, the time (in microseconds) of a new fan pulse that
82
94
// has just occurred, which means that segment drawing needs to be
83
95
// restarted
84
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
85
97
 
86
98
// the time (in microseconds) when the last fan pulse occurred
87
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
88
100
 
89
101
// duration (in microseconds) that a segment should be displayed
90
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
91
103
 
92
104
// remainder after divisor and a tally of the remainders for each segment
93
 
static unsigned long segment_step_sub_step = 0;
94
 
static unsigned long segment_step_sub = 0;
95
 
 
96
 
// flag to indicate that the drawing mode should be cycled to the next one
97
 
static bool inc_draw_mode = false;
98
 
 
99
 
// a bounce-managed button
100
 
static Bounce button( 3, 5 );
101
 
 
102
 
// the time
103
 
static int time_hours = 0;
104
 
static int time_minutes = 0;
105
 
static int time_seconds = 0;
106
 
 
107
 
// number of segments in a full display (rotation) is 60 (one per
108
 
// second) times the desired number of sub-divisions of a second
109
 
#define NUM_SECOND_SEGMENTS 5
110
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
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
111
121
 
112
122
//_____________________________________________________________________________
113
123
//                                                                         code
114
124
 
115
125
 
116
 
// check for button presses
117
 
void checkButtons()
118
 
{
119
 
        // update buttons
120
 
        button.update();
121
 
 
122
 
        // notice button presses
123
 
        if( button.risingEdge() )
124
 
                inc_draw_mode = true;
125
 
}
126
 
 
127
 
 
128
 
// keep track of time
129
 
void trackTime()
130
 
{
131
 
        // previous time and any carried-over milliseconds
132
 
        static unsigned long last_time = millis();
133
 
        static unsigned long carry = 0;
134
 
 
135
 
        // how many milliseonds have elapsed since we last checked?
136
 
        unsigned long next_time = millis();
137
 
        unsigned long delta = next_time - last_time + carry;
138
 
 
139
 
        // update the previous time and carried-over milliseconds
140
 
        last_time = next_time;
141
 
        carry = delta % 1000;
142
 
 
143
 
        // add the seconds that have passed to the time
144
 
        time_seconds += delta / 1000;
145
 
        while( time_seconds >= 60 ) {
146
 
                time_seconds -= 60;
147
 
                time_minutes++;
148
 
                if( time_minutes >= 60 ) {
149
 
                        time_minutes -= 60;
150
 
                        time_hours++;
151
 
                        if( time_hours >= 24 )
152
 
                                time_hours -= 24;
 
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;
153
198
                }
154
199
        }
155
200
}
156
201
 
157
202
 
158
 
// draw a segment for the test display
159
 
void drawNextSegment_test( bool reset )
 
203
// draw a display segment
 
204
void draw_next_segment( bool reset )
160
205
{
161
206
        // keep track of segment
162
 
        static unsigned int segment = 0;
163
 
        if( reset ) segment = 0;
164
 
        segment++;
165
 
 
166
 
        // turn on inside and outside LEDs
167
 
        digitalWrite( 4, HIGH );
168
 
        digitalWrite( 13, HIGH );
169
 
 
170
 
        // display segment number in binary across in the inside LEDs,
171
 
        // with the LED on pin 12 showing the least-significant bit
172
 
        for( int a = 0; a < 8; a++ )
173
 
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
174
 
}
175
 
 
176
 
 
177
 
// draw a segment for the time display
178
 
void drawNextSegment_time( bool reset )
179
 
{
180
 
        static unsigned int second = 0;
181
 
        static unsigned int segment = 0;
182
 
 
183
 
        // handle display reset
 
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
184
219
        if( reset ) {
185
 
                second = 0;
186
 
                segment = 0;
187
 
        }
188
 
 
189
 
        // what needs to be drawn?
190
 
        bool draw_tick = !segment && second % 5 == 0;
191
 
        bool draw_second = !segment && second == time_seconds;
192
 
        bool draw_minute = !segment && second == time_minutes;
193
 
        bool draw_hour = !segment && second == time_hours;
194
 
 
195
 
        // set the LEDs
196
 
        digitalWrite( 13, HIGH );
197
 
        digitalWrite( 12, draw_tick || draw_minute );
198
 
        for( int a = 10; a <= 11; a++ )
199
 
                digitalWrite( a, draw_minute || draw_second );
200
 
        for( int a = 4; a <= 9; a++ )
201
 
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
202
 
 
203
 
        // inc position
204
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
205
 
                segment = 0;
206
 
                second++;
207
 
        }
208
 
}
209
 
 
210
 
 
211
 
// draw a display segment
212
 
void drawNextSegment( bool reset )
213
 
{
214
 
        static int draw_mode = 0;
215
 
 
216
 
        // handle mode switch requests
217
 
        if( reset && inc_draw_mode ) {
218
 
                inc_draw_mode = false;
219
 
                draw_mode++;
220
 
                if( draw_mode >= 2 )
221
 
                        draw_mode = 0;
222
 
        }
223
 
 
224
 
        // draw the segment
225
 
        switch( draw_mode ) {
226
 
        case 0: drawNextSegment_test( reset ); break;
227
 
        case 1: drawNextSegment_time( reset ); break;
228
 
        }
 
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
229
254
}
230
255
 
231
256
 
232
257
// calculate time constants when a new pulse has occurred
233
 
void calculateSegmentTimes()
 
258
void calculate_segment_times()
234
259
{
235
260
        // check for overflows, and only recalculate times if there isn't
236
261
        // one (if there is, we'll just go with the last pulse's times)
237
 
        if( new_pulse_at > last_pulse_at )
 
262
        if( _new_pulse_at > _last_pulse_at )
238
263
        {
239
264
                // new segment stepping times
240
 
                unsigned long delta = new_pulse_at - last_pulse_at;
241
 
                segment_step = delta / NUM_SEGMENTS;
242
 
                segment_step_sub = 0;
243
 
                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;
244
269
        }
245
270
 
246
271
        // now we have dealt with this pulse, save the pulse time and
247
272
        // clear new_pulse_at, ready for the next pulse
248
 
        last_pulse_at = new_pulse_at;
249
 
        new_pulse_at = 0;
 
273
        _last_pulse_at = _new_pulse_at;
 
274
        _new_pulse_at = 0;
250
275
}
251
276
 
252
277
 
253
278
// wait until it is time to draw the next segment or a new pulse has
254
279
// occurred
255
 
void waitTillNextSegment( bool reset )
 
280
void wait_till_end_of_segment( bool reset )
256
281
{
257
282
        static unsigned long end_time = 0;
258
283
 
259
284
        // handle reset
260
285
        if( reset )
261
 
                end_time = last_pulse_at;
 
286
                end_time = _last_pulse_at;
262
287
 
263
288
        // work out the time that this segment should be displayed until
264
 
        end_time += segment_step;
265
 
        segment_step_sub += segment_step_sub_step;
266
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
267
 
                segment_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;
268
293
                end_time++;
269
294
        }
270
295
 
271
296
        // wait
272
 
        while( micros() < end_time && !new_pulse_at );
 
297
        while( micros() < end_time && !_new_pulse_at );
273
298
}
274
299
 
275
300
 
276
301
// ISR to handle the pulses from the fan's tachiometer
277
 
void fanPulseHandler()
 
302
void fan_pulse_handler()
278
303
{
279
304
        // the fan actually sends two pulses per revolution. These pulses
280
305
        // may not be exactly evenly distributed around the rotation, so
285
310
        if( !ignore )
286
311
        {
287
312
                // set a new pulse time
288
 
                new_pulse_at = micros();
 
313
                _new_pulse_at = micros();
289
314
        }
290
315
}
291
316
 
294
319
void setup()
295
320
{
296
321
        // set up an interrupt handler on pin 2 to nitice fan pulses
297
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
322
        attachInterrupt( 0, fan_pulse_handler, RISING );
298
323
        digitalWrite( 2, HIGH );
299
324
  
300
325
        // set up output pins (4 to 13) for the led array
303
328
 
304
329
        // set up mode-switch button on pin 3
305
330
        pinMode( 3, INPUT );
306
 
 
307
 
        // serial comms
308
 
        Serial.begin( 9600 );
 
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();
309
343
}
310
344
 
311
345
 
313
347
void loop()
314
348
{
315
349
        // if there has been a new pulse, we'll be resetting the display
316
 
        bool reset = new_pulse_at? true : false;
 
350
        bool reset = _new_pulse_at? true : false;
 
351
 
 
352
        // update button
 
353
        _button.update();
317
354
 
318
355
        // only do this stuff at the start of a display cycle, to ensure
319
356
        // that no state changes mid-display
320
357
        if( reset )
321
358
        {
322
 
                // check buttons
323
 
                checkButtons();
 
359
                // calculate segment times
 
360
                calculate_segment_times();
324
361
 
325
362
                // keep track of time
326
 
                trackTime();
 
363
                Time::update();
 
364
 
 
365
                // perform button events
 
366
                do_button_events();
327
367
        }
328
368
 
329
369
        // draw this segment
330
 
        drawNextSegment( reset );
331
 
 
332
 
        // do we need to recalculate segment times?
333
 
        if( reset )
334
 
                calculateSegmentTimes();
 
370
        draw_next_segment( reset );
335
371
 
336
372
        // wait till it's time to draw the next segment
337
 
        waitTillNextSegment( reset );
 
373
        wait_till_end_of_segment( reset );
338
374
}