/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.ino

  • Committer: edam
  • Date: 2012-02-02 01:19:19 UTC
  • Revision ID: edam@waxworlds.org-20120202011919-rcu4pt8mq8pieujs
modified schematic and updated notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
1
/*
3
2
 * propeller-clock.ino
4
3
 *
28
27
 
29
28
 * a PC fan is wired up to a 12V power supply
30
29
 
31
 
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
32
 
   Arduino.
 
30
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
 
31
   arduino.
33
32
 
34
 
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
 
33
 * the pins 4 to 13 on the arduino should directly drive an LED (the
35
34
   LED on pin 4 is in the centre of the clock face and the LED on pin
36
35
   13 is at the outside.
37
36
 
38
37
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
39
38
   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.
 
39
   LEDs that turn on anf off in unison in the centre of the clock.
41
40
 
42
41
 * a button should be attached to pin 3 that grounds it when pressed.
43
42
 
44
 
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
 
43
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
45
44
 
46
45
Implementation details:
47
46
 
50
49
 * the timing of the drawing of the clock face is recalculated with
51
50
   every rotation of the propeller.
52
51
    
53
 
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
 
52
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
54
53
   software skips every other one. This means that the clock may
55
54
   appear upside-down if started with the propeller in the wrong
56
 
   position. You will need to experiment to discover the position that
 
55
   position. You will need to experiment to dicsover the position that
57
56
   the propeller must be in when starting the clock.
58
57
    
59
58
Usage instructions:
75
74
 
76
75
******************************************************************************/
77
76
 
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"
 
77
 
 
78
#include <Bounce.h>
 
79
#include <DS1307.h>
 
80
#include <Wire.h>
85
81
 
86
82
//_____________________________________________________________________________
87
83
//                                                                         data
88
84
 
 
85
 
89
86
// when non-zero, the time (in microseconds) of a new fan pulse that
90
87
// has just occurred, which means that segment drawing needs to be
91
88
// restarted
92
 
static unsigned long _new_pulse_at = 0;
 
89
static unsigned long new_pulse_at = 0;
93
90
 
94
91
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long _last_pulse_at = 0;
 
92
static unsigned long last_pulse_at = 0;
96
93
 
97
94
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long _segment_step = 0;
 
95
static unsigned long segment_step = 0;
99
96
 
100
97
// remainder after divisor and a tally of the remainders for each segment
101
 
static unsigned long _segment_step_sub_step = 0;
102
 
static unsigned long _segment_step_sub = 0;
103
 
 
104
 
// the button
105
 
static Button _button( 3 );
106
 
 
107
 
// modes
108
 
static int _major_mode = 0;
109
 
static int _minor_mode = 0;
110
 
 
111
 
#define MAIN_MODE_IDX 0
112
 
 
113
 
#define ANALOGUE_CLOCK_IDX 0
114
 
#define DIGITAL_CLOCK_IDX 1
115
 
#define TEST_PATTERN_IDX 2
 
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 )
116
116
 
117
117
//_____________________________________________________________________________
118
118
//                                                                         code
119
119
 
120
120
 
121
 
// activate the current minor mode
122
 
void activate_minor_mode()
 
121
// check for button presses
 
122
void checkButtons()
123
123
{
124
 
        switch( _minor_mode ) {
125
 
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
126
 
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
127
 
        }
 
124
        // update buttons
 
125
        button.update();
 
126
 
 
127
        // notice button presses
 
128
        if( button.risingEdge() )
 
129
                inc_draw_mode = true;
128
130
}
129
131
 
130
 
// perform button events
131
 
void do_button_events()
 
132
 
 
133
// keep track of time
 
134
void trackTime()
132
135
{
133
 
        // loop through pending events
134
 
        while( int event = _button.get_event() )
135
 
        {
136
 
                switch( event )
137
 
                {
138
 
                case 1:
139
 
                        // short press
140
 
                        switch( _major_mode ) {
141
 
                        case MAIN_MODE_IDX:
142
 
                                switch( _minor_mode ) {
143
 
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
144
 
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
145
 
                                }
146
 
                                break;
147
 
                        }
148
 
                        break;
149
 
 
150
 
                case 2:
151
 
                        // long press
152
 
                        switch( _major_mode ) {
153
 
                        case MAIN_MODE_IDX:
154
 
                                if( ++_minor_mode >= 3 )
155
 
                                        _minor_mode = 0;
156
 
                                switch( _minor_mode ) {
157
 
                                case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
158
 
                                }
159
 
                                break;
160
 
                        }
161
 
                        break;
162
 
 
163
 
                case 3:
164
 
                        // looooong press (change major mode)
165
 
                        if( ++_major_mode > 0 )
166
 
                                _major_mode = 0;
167
 
                        switch( _major_mode ) {
168
 
                        case MAIN_MODE_IDX: _minor_mode = 0; break;
169
 
                        }
170
 
                        activate_minor_mode();
171
 
                        break;
 
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;
172
158
                }
173
159
        }
174
160
}
175
161
 
176
162
 
177
 
// draw a display segment
178
 
void draw_next_segment( bool reset )
 
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 )
179
180
{
180
181
        // keep track of segment
181
 
#if CLOCK_FORWARD
182
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
183
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
184
 
#else
185
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
186
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
187
 
#endif
188
 
 
189
 
        // frame reset
 
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
190
204
        if( reset ) {
191
 
                switch( _major_mode ) {
192
 
                case MAIN_MODE_IDX:
193
 
                        switch( _minor_mode ) {
194
 
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
195
 
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
196
 
                        }
197
 
                        break;
198
 
                }
199
 
        }
200
 
 
201
 
        // draw
202
 
        switch( _major_mode ) {
203
 
        case MAIN_MODE_IDX:
204
 
                switch( _minor_mode ) {
205
 
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
206
 
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
207
 
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
208
 
                }
209
 
                break;
210
 
        }
211
 
 
212
 
#if CLOCK_FORWARD
213
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
214
 
#else
215
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
216
 
#endif
 
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
        }
217
249
}
218
250
 
219
251
 
220
252
// calculate time constants when a new pulse has occurred
221
 
void calculate_segment_times()
 
253
void calculateSegmentTimes()
222
254
{
223
255
        // check for overflows, and only recalculate times if there isn't
224
256
        // one (if there is, we'll just go with the last pulse's times)
225
 
        if( _new_pulse_at > _last_pulse_at )
 
257
        if( new_pulse_at > last_pulse_at )
226
258
        {
227
259
                // new segment stepping times
228
 
                unsigned long delta = _new_pulse_at - _last_pulse_at;
229
 
                _segment_step = delta / NUM_SEGMENTS;
230
 
                _segment_step_sub = 0;
231
 
                _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;
232
264
        }
233
265
 
234
266
        // now we have dealt with this pulse, save the pulse time and
235
267
        // clear new_pulse_at, ready for the next pulse
236
 
        _last_pulse_at = _new_pulse_at;
237
 
        _new_pulse_at = 0;
 
268
        last_pulse_at = new_pulse_at;
 
269
        new_pulse_at = 0;
238
270
}
239
271
 
240
272
 
241
273
// wait until it is time to draw the next segment or a new pulse has
242
274
// occurred
243
 
void wait_till_end_of_segment( bool reset )
 
275
void waitTillNextSegment( bool reset )
244
276
{
245
277
        static unsigned long end_time = 0;
246
278
 
247
279
        // handle reset
248
280
        if( reset )
249
 
                end_time = _last_pulse_at;
 
281
                end_time = last_pulse_at;
250
282
 
251
283
        // work out the time that this segment should be displayed until
252
 
        end_time += _segment_step;
253
 
        _segment_step_sub += _segment_step_sub_step;
254
 
        if( _segment_step_sub >= NUM_SEGMENTS ) {
255
 
                _segment_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;
256
288
                end_time++;
257
289
        }
258
290
 
259
291
        // wait
260
 
        while( micros() < end_time && !_new_pulse_at );
 
292
        while( micros() < end_time && !new_pulse_at );
261
293
}
262
294
 
263
295
 
264
296
// ISR to handle the pulses from the fan's tachiometer
265
 
void fan_pulse_handler()
 
297
void fanPulseHandler()
266
298
{
267
299
        // the fan actually sends two pulses per revolution. These pulses
268
300
        // may not be exactly evenly distributed around the rotation, so
273
305
        if( !ignore )
274
306
        {
275
307
                // set a new pulse time
276
 
                _new_pulse_at = micros();
 
308
                new_pulse_at = micros();
277
309
        }
278
310
}
279
311
 
282
314
void setup()
283
315
{
284
316
        // set up an interrupt handler on pin 2 to nitice fan pulses
285
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
317
        attachInterrupt( 0, fanPulseHandler, RISING );
286
318
        digitalWrite( 2, HIGH );
287
319
  
288
320
        // set up output pins (4 to 13) for the led array
291
323
 
292
324
        // set up mode-switch button on pin 3
293
325
        pinMode( 3, INPUT );
294
 
        digitalWrite( 3, HIGH );
295
 
        static int event_times[] = { 5, 500, 4000, 0 };
296
 
        _button.set_event_times( event_times );
297
 
 
298
 
        // initialise RTC
299
 
        Time::init();
300
 
 
301
 
        // activate the minor mode
302
 
        switch( _major_mode ) {
303
 
        case MAIN_MODE_IDX: activate_minor_mode(); break;
304
 
        }
 
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 );
305
336
}
306
337
 
307
338
 
309
340
void loop()
310
341
{
311
342
        // if there has been a new pulse, we'll be resetting the display
312
 
        bool reset = _new_pulse_at? true : false;
313
 
 
314
 
        // update button
315
 
        _button.update();
 
343
        bool reset = new_pulse_at? true : false;
316
344
 
317
345
        // only do this stuff at the start of a display cycle, to ensure
318
346
        // that no state changes mid-display
319
347
        if( reset )
320
348
        {
321
 
                // calculate segment times
322
 
                calculate_segment_times();
 
349
                // check buttons
 
350
                checkButtons();
323
351
 
324
352
                // keep track of time
325
 
                Time::update();
326
 
 
327
 
                // perform button events
328
 
                do_button_events();
 
353
                trackTime();
329
354
        }
330
355
 
331
356
        // draw this segment
332
 
        draw_next_segment( reset );
 
357
        drawNextSegment( reset );
 
358
 
 
359
        // do we need to recalculate segment times?
 
360
        if( reset )
 
361
                calculateSegmentTimes();
333
362
 
334
363
        // wait till it's time to draw the next segment
335
 
        wait_till_end_of_segment( reset );
 
364
        waitTillNextSegment( reset );
336
365
}