/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-17 22:49:11 UTC
  • Revision ID: tim@ed.am-20120517224911-dbd9dtcpl14xlhi0
rewrote/fixed button event triggering code

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
39
   used to indirectly drive a transistor which in turn drives several
39
 
   LEDs that turn on anf off in unison in the centre of the clock.
 
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
 
43
 
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
 
44
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
44
45
 
45
46
Implementation details:
46
47
 
49
50
 * the timing of the drawing of the clock face is recalculated with
50
51
   every rotation of the propeller.
51
52
    
52
 
 * 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
53
54
   software skips every other one. This means that the clock may
54
55
   appear upside-down if started with the propeller in the wrong
55
 
   position. You will need to experiment to dicsover the position that
 
56
   position. You will need to experiment to discover the position that
56
57
   the propeller must be in when starting the clock.
57
58
    
58
59
Usage instructions:
74
75
 
75
76
******************************************************************************/
76
77
 
77
 
 
78
 
#include <Bounce.h>
79
 
#include <DS1307.h>
80
 
#include <Wire.h>
 
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 "modes/info_mode.h"
 
87
#include "text.h"
 
88
#include "text_renderer.h"
 
89
#include "common.h"
81
90
 
82
91
//_____________________________________________________________________________
83
92
//                                                                         data
84
93
 
85
 
 
86
94
// when non-zero, the time (in microseconds) of a new fan pulse that
87
95
// has just occurred, which means that segment drawing needs to be
88
96
// restarted
89
 
static unsigned long new_pulse_at = 0;
 
97
static unsigned long _new_pulse_at = 0;
90
98
 
91
99
// the time (in microseconds) when the last fan pulse occurred
92
 
static unsigned long last_pulse_at = 0;
 
100
static unsigned long _last_pulse_at = 0;
93
101
 
94
102
// duration (in microseconds) that a segment should be displayed
95
 
static unsigned long segment_step = 0;
 
103
static unsigned long _segment_step = 0;
96
104
 
97
105
// remainder after divisor and a tally of the remainders for each segment
98
 
static unsigned long segment_step_sub_step = 0;
99
 
static unsigned long segment_step_sub = 0;
100
 
 
101
 
// flag to indicate that the drawing mode should be cycled to the next one
102
 
static bool inc_draw_mode = false;
103
 
 
104
 
// a bounce-managed button
105
 
static Bounce button( 3, 5 );
106
 
 
107
 
// the time
108
 
static int time_hours = 0;
109
 
static int time_minutes = 0;
110
 
static int time_seconds = 0;
111
 
 
112
 
// number of segments in a full display (rotation) is 60 (one per
113
 
// second) times the desired number of sub-divisions of a second
114
 
#define NUM_SECOND_SEGMENTS 5
115
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
106
static unsigned long _segment_step_sub_step = 0;
 
107
static unsigned long _segment_step_sub = 0;
 
108
 
 
109
// the button
 
110
static Button _button( 3 );
 
111
 
 
112
// modes
 
113
static int _major_mode = 0;
 
114
static int _minor_mode = 0;
 
115
 
 
116
#define MAIN_MODE_IDX 1
 
117
#define SETTINGS_MODE_IDX 0
 
118
 
 
119
#define ANALOGUE_CLOCK_IDX 0
 
120
#define DIGITAL_CLOCK_IDX 1
 
121
#define TEST_PATTERN_IDX 2
 
122
#define INFO_MODE_IDX 3
116
123
 
117
124
//_____________________________________________________________________________
118
125
//                                                                         code
119
126
 
120
127
 
121
 
// check for button presses
122
 
void checkButtons()
123
 
{
124
 
        // update buttons
125
 
        button.update();
126
 
 
127
 
        // notice button presses
128
 
        if( button.risingEdge() )
129
 
                inc_draw_mode = true;
130
 
}
131
 
 
132
 
 
133
 
// keep track of time
134
 
void trackTime()
135
 
{
136
 
        // previous time and any carried-over milliseconds
137
 
        static unsigned long last_time = millis();
138
 
        static unsigned long carry = 0;
139
 
 
140
 
        // how many milliseonds have elapsed since we last checked?
141
 
        unsigned long next_time = millis();
142
 
        unsigned long delta = next_time - last_time + carry;
143
 
 
144
 
        // update the previous time and carried-over milliseconds
145
 
        last_time = next_time;
146
 
        carry = delta % 1000;
147
 
 
148
 
        // add the seconds that have passed to the time
149
 
        time_seconds += delta / 1000;
150
 
        while( time_seconds >= 60 ) {
151
 
                time_seconds -= 60;
152
 
                time_minutes++;
153
 
                if( time_minutes >= 60 ) {
154
 
                        time_minutes -= 60;
155
 
                        time_hours++;
156
 
                        if( time_hours >= 24 )
157
 
                                time_hours -= 24;
 
128
// activate the current minor mode
 
129
void activate_minor_mode()
 
130
{
 
131
        // reset text
 
132
        Text::reset();
 
133
        leds_off();
 
134
 
 
135
        // give the mode a chance to init
 
136
        switch( _minor_mode ) {
 
137
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
 
138
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
139
        case INFO_MODE_IDX: info_mode_activate(); break;
 
140
        }
 
141
}
 
142
 
 
143
 
 
144
// activate major mode
 
145
void activate_major_mode()
 
146
{
 
147
        // reset text
 
148
        Text::reset();
 
149
        leds_off();
 
150
 
 
151
        // reset buttons
 
152
        _button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
 
153
 
 
154
        // give the mode a chance to init
 
155
        switch( _major_mode ) {
 
156
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
157
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
 
158
        }
 
159
}
 
160
 
 
161
 
 
162
// perform button events
 
163
void do_button_events()
 
164
{
 
165
        // loop through pending events
 
166
        while( int event = _button.get_event() )
 
167
        {
 
168
                switch( event )
 
169
                {
 
170
                case 1:
 
171
                        // short press
 
172
                        switch( _major_mode ) {
 
173
                        case MAIN_MODE_IDX:
 
174
                                switch( _minor_mode ) {
 
175
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
176
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
177
                                case INFO_MODE_IDX: info_mode_press(); break;
 
178
                                }
 
179
                                break;
 
180
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
 
181
                        }
 
182
                        break;
 
183
 
 
184
                case 2:
 
185
                        // long press
 
186
                        switch( _major_mode ) {
 
187
                        case MAIN_MODE_IDX:
 
188
                                if( ++_minor_mode >= 3 )
 
189
                                        _minor_mode = 0;
 
190
                                activate_minor_mode();
 
191
                                break;
 
192
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
 
193
                        }
 
194
                        break;
 
195
 
 
196
                case 3:
 
197
                        // looooong press (change major mode)
 
198
                        if( ++_major_mode > 1 )
 
199
                                _major_mode = 0;
 
200
                        activate_major_mode();
 
201
                        break;
158
202
                }
159
203
        }
160
204
}
161
205
 
162
206
 
163
 
// turn an led on/off
164
 
void ledOn( int num, bool on )
165
 
{
166
 
        if( num < 0 || num > 9 ) return;
167
 
 
168
 
        // convert to pin no.
169
 
        num += 4;
170
 
 
171
 
        // pin 4 needs to be inverted (it's driving a PNP)
172
 
        if( num == 4 ) on = !on;
173
 
 
174
 
        digitalWrite( num, on? HIGH : LOW );
175
 
}
176
 
 
177
 
 
178
 
// draw a segment for the test display
179
 
void drawNextSegment_test( bool reset )
 
207
// draw a display segment
 
208
void draw_next_segment( bool reset )
180
209
{
181
210
        // keep track of segment
182
 
        static unsigned int segment = 0;
183
 
        if( reset ) segment = 0;
184
 
        segment++;
185
 
 
186
 
        // turn on inside and outside LEDs
187
 
        ledOn( 0, true );
188
 
        ledOn( 9, true );
189
 
 
190
 
        // display segment number in binary across in the inside LEDs,
191
 
        // with the LED on pin 12 showing the least-significant bit
192
 
        for( int a = 0; a < 8; a++ )
193
 
                ledOn( 8 - a, ( segment >> a ) & 1 );
194
 
}
195
 
 
196
 
 
197
 
// draw a segment for the time display
198
 
void drawNextSegment_time( bool reset )
199
 
{
200
 
        static int second = 0;
201
 
        static int segment = 0;
202
 
 
203
 
        // handle display reset
 
211
#if CLOCK_FORWARD
 
212
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
213
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
214
#else
 
215
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
216
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
217
#endif
 
218
 
 
219
        // reset the text renderer
 
220
        TextRenderer::reset_buffer();
 
221
 
 
222
        // frame reset
204
223
        if( reset ) {
205
 
                second = 0;
206
 
                segment = 0;
207
 
        }
208
 
 
209
 
        // what needs to be drawn?
210
 
        bool draw_tick = !segment && second % 5 == 0;
211
 
        bool draw_second = !segment && second == time_seconds;
212
 
        bool draw_minute = !segment && second == time_minutes;
213
 
        bool draw_hour = !segment && second == time_hours;
214
 
 
215
 
        // set the LEDs
216
 
        ledOn( 9, true );
217
 
        ledOn( 8, draw_tick || draw_minute );
218
 
        for( int a = 6; a <= 7; a++ )
219
 
                ledOn( a, draw_minute || draw_second );
220
 
        for( int a = 0; a <= 5; a++ )
221
 
                ledOn( a, draw_minute || draw_second || draw_hour );
222
 
 
223
 
        // inc position
224
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
225
 
                segment = 0;
226
 
                second++;
227
 
        }
228
 
}
229
 
 
230
 
 
231
 
// draw a display segment
232
 
void drawNextSegment( bool reset )
233
 
{
234
 
        static int draw_mode = 0;
235
 
 
236
 
        // handle mode switch requests
237
 
        if( reset && inc_draw_mode ) {
238
 
                inc_draw_mode = false;
239
 
                draw_mode++;
240
 
                if( draw_mode >= 2 )
241
 
                        draw_mode = 0;
242
 
        }
243
 
 
244
 
        // draw the segment
245
 
        switch( draw_mode ) {
246
 
        case 0: drawNextSegment_test( reset ); break;
247
 
        case 1: drawNextSegment_time( reset ); break;
248
 
        }
 
224
                switch( _major_mode ) {
 
225
                case MAIN_MODE_IDX:
 
226
                        switch( _minor_mode ) {
 
227
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
228
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
229
                        case INFO_MODE_IDX: info_mode_draw_reset(); break;
 
230
                        }
 
231
                        break;
 
232
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
 
233
                }
 
234
 
 
235
                // tell the text services we're starting a new frame
 
236
                Text::draw_reset();
 
237
        }
 
238
 
 
239
        // draw
 
240
        switch( _major_mode ) {
 
241
        case MAIN_MODE_IDX:
 
242
                switch( _minor_mode ) {
 
243
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
244
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
245
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
246
                case INFO_MODE_IDX: info_mode_draw( segment ); break;
 
247
                }
 
248
                break;
 
249
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
 
250
        }
 
251
 
 
252
        // draw any text that was rendered
 
253
        TextRenderer::output_buffer();
 
254
 
 
255
#if CLOCK_FORWARD
 
256
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
257
#else
 
258
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
259
#endif
249
260
}
250
261
 
251
262
 
252
263
// calculate time constants when a new pulse has occurred
253
 
void calculateSegmentTimes()
 
264
void calculate_segment_times()
254
265
{
255
266
        // check for overflows, and only recalculate times if there isn't
256
267
        // one (if there is, we'll just go with the last pulse's times)
257
 
        if( new_pulse_at > last_pulse_at )
 
268
        if( _new_pulse_at > _last_pulse_at )
258
269
        {
259
270
                // 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;
 
271
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
272
                _segment_step = delta / NUM_SEGMENTS;
 
273
                _segment_step_sub = 0;
 
274
                _segment_step_sub_step = delta % NUM_SEGMENTS;
264
275
        }
265
276
 
266
277
        // now we have dealt with this pulse, save the pulse time and
267
278
        // clear new_pulse_at, ready for the next pulse
268
 
        last_pulse_at = new_pulse_at;
269
 
        new_pulse_at = 0;
 
279
        _last_pulse_at = _new_pulse_at;
 
280
        _new_pulse_at = 0;
270
281
}
271
282
 
272
283
 
273
284
// wait until it is time to draw the next segment or a new pulse has
274
285
// occurred
275
 
void waitTillNextSegment( bool reset )
 
286
void wait_till_end_of_segment( bool reset )
276
287
{
277
288
        static unsigned long end_time = 0;
278
289
 
279
290
        // handle reset
280
291
        if( reset )
281
 
                end_time = last_pulse_at;
 
292
                end_time = _last_pulse_at;
282
293
 
283
294
        // 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;
 
295
        end_time += _segment_step;
 
296
        _segment_step_sub += _segment_step_sub_step;
 
297
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
298
                _segment_step_sub -= NUM_SEGMENTS;
288
299
                end_time++;
289
300
        }
290
301
 
291
302
        // wait
292
 
        while( micros() < end_time && !new_pulse_at );
 
303
        while( micros() < end_time && !_new_pulse_at );
293
304
}
294
305
 
295
306
 
296
 
// ISR to handle the pulses from the fan's tachiometer
297
 
void fanPulseHandler()
 
307
// ISR to handle the pulses from the fan's tachometer
 
308
void fan_pulse_handler()
298
309
{
299
310
        // the fan actually sends two pulses per revolution. These pulses
300
311
        // may not be exactly evenly distributed around the rotation, so
305
316
        if( !ignore )
306
317
        {
307
318
                // set a new pulse time
308
 
                new_pulse_at = micros();
 
319
                _new_pulse_at = micros();
309
320
        }
310
321
}
311
322
 
313
324
// main setup
314
325
void setup()
315
326
{
316
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
317
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
327
        // set up an interrupt handler on pin 2 to notice fan pulses
 
328
        attachInterrupt( 0, fan_pulse_handler, RISING );
318
329
        digitalWrite( 2, HIGH );
319
330
  
320
331
        // set up output pins (4 to 13) for the led array
323
334
 
324
335
        // set up mode-switch button on pin 3
325
336
        pinMode( 3, INPUT );
326
 
 
327
 
        // get the time from the real-time clock
328
 
        int rtc_data[ 7 ];
329
 
        RTC.get( rtc_data, true );
330
 
        time_hours = rtc_data[ DS1307_HR ];
331
 
        time_minutes = rtc_data[ DS1307_MIN ];
332
 
        time_seconds = rtc_data[ DS1307_SEC ];
333
 
 
334
 
        // serial comms
335
 
        Serial.begin( 9600 );
 
337
        digitalWrite( 3, HIGH );
 
338
        static int event_times[] = { 5, 500, 4000, 0 };
 
339
        _button.set_event_times( event_times );
 
340
 
 
341
        // initialise RTC
 
342
        Time::init();
 
343
 
 
344
        // init text renderer
 
345
        TextRenderer::init();
 
346
 
 
347
        // activate the minor mode
 
348
        activate_major_mode();
336
349
}
337
350
 
338
351
 
340
353
void loop()
341
354
{
342
355
        // if there has been a new pulse, we'll be resetting the display
343
 
        bool reset = new_pulse_at? true : false;
 
356
        bool reset = _new_pulse_at? true : false;
 
357
 
 
358
        // update button
 
359
        _button.update();
344
360
 
345
361
        // only do this stuff at the start of a display cycle, to ensure
346
362
        // that no state changes mid-display
347
363
        if( reset )
348
364
        {
349
 
                // check buttons
350
 
                checkButtons();
 
365
                // calculate segment times
 
366
                calculate_segment_times();
351
367
 
352
368
                // keep track of time
353
 
                trackTime();
 
369
                Time::update();
 
370
 
 
371
                // perform button events
 
372
                do_button_events();
354
373
        }
355
374
 
356
375
        // draw this segment
357
 
        drawNextSegment( reset );
358
 
 
359
 
        // do we need to recalculate segment times?
360
 
        if( reset )
361
 
                calculateSegmentTimes();
 
376
        draw_next_segment( reset );
362
377
 
363
378
        // wait till it's time to draw the next segment
364
 
        waitTillNextSegment( reset );
 
379
        wait_till_end_of_segment( reset );
365
380
}