/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-03-10 13:04:29 UTC
  • Revision ID: tim@ed.am-20120310130429-310w5ejo968mc6mo
cleaned-up notes

Show diffs side-by-side

added added

removed removed

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 "analogue_clock.h"
 
83
#include "digital_clock.h"
 
84
#include "test_pattern.h"
81
85
 
82
86
//_____________________________________________________________________________
83
87
//                                                                         data
84
88
 
85
 
 
86
89
// when non-zero, the time (in microseconds) of a new fan pulse that
87
90
// has just occurred, which means that segment drawing needs to be
88
91
// restarted
89
 
static unsigned long new_pulse_at = 0;
 
92
static unsigned long _new_pulse_at = 0;
90
93
 
91
94
// the time (in microseconds) when the last fan pulse occurred
92
 
static unsigned long last_pulse_at = 0;
 
95
static unsigned long _last_pulse_at = 0;
93
96
 
94
97
// duration (in microseconds) that a segment should be displayed
95
 
static unsigned long segment_step = 0;
 
98
static unsigned long _segment_step = 0;
96
99
 
97
100
// 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 )
 
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
116
116
 
117
117
//_____________________________________________________________________________
118
118
//                                                                         code
119
119
 
120
120
 
121
 
// check for button presses
122
 
void checkButtons()
 
121
// activate the current minor mode
 
122
void activate_minor_mode()
123
123
{
124
 
        // update buttons
125
 
        button.update();
126
 
 
127
 
        // notice button presses
128
 
        if( button.risingEdge() )
129
 
                inc_draw_mode = true;
 
124
        switch( _minor_mode ) {
 
125
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
 
126
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
127
        }
130
128
}
131
129
 
132
 
 
133
 
// keep track of time
134
 
void trackTime()
 
130
// perform button events
 
131
void do_button_events()
135
132
{
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;
 
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;
158
172
                }
159
173
        }
160
174
}
161
175
 
162
176
 
163
 
// draw a segment for the test display
164
 
void drawNextSegment_test( bool reset )
 
177
// draw a display segment
 
178
void draw_next_segment( bool reset )
165
179
{
166
180
        // keep track of segment
167
 
        static unsigned int segment = 0;
168
 
        if( reset ) segment = 0;
169
 
        segment++;
170
 
 
171
 
        // turn on inside and outside LEDs
172
 
        digitalWrite( 4, HIGH );
173
 
        digitalWrite( 13, HIGH );
174
 
 
175
 
        // display segment number in binary across in the inside LEDs,
176
 
        // with the LED on pin 12 showing the least-significant bit
177
 
        for( int a = 0; a < 8; a++ )
178
 
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
179
 
}
180
 
 
181
 
 
182
 
// draw a segment for the time display
183
 
void drawNextSegment_time( bool reset )
184
 
{
185
 
        static unsigned int second = 0;
186
 
        static unsigned int segment = 0;
187
 
 
188
 
        // handle display reset
 
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
189
190
        if( reset ) {
190
 
                second = 0;
191
 
                segment = 0;
192
 
        }
193
 
 
194
 
        // what needs to be drawn?
195
 
        bool draw_tick = !segment && second % 5 == 0;
196
 
        bool draw_second = !segment && second == time_seconds;
197
 
        bool draw_minute = !segment && second == time_minutes;
198
 
        bool draw_hour = !segment && second == time_hours;
199
 
 
200
 
        // set the LEDs
201
 
        digitalWrite( 13, HIGH );
202
 
        digitalWrite( 12, draw_tick || draw_minute );
203
 
        for( int a = 10; a <= 11; a++ )
204
 
                digitalWrite( a, draw_minute || draw_second );
205
 
        for( int a = 4; a <= 9; a++ )
206
 
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
207
 
 
208
 
        // inc position
209
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
210
 
                segment = 0;
211
 
                second++;
212
 
        }
213
 
}
214
 
 
215
 
 
216
 
// draw a display segment
217
 
void drawNextSegment( bool reset )
218
 
{
219
 
        static int draw_mode = 0;
220
 
 
221
 
        // handle mode switch requests
222
 
        if( reset && inc_draw_mode ) {
223
 
                inc_draw_mode = false;
224
 
                draw_mode++;
225
 
                if( draw_mode >= 2 )
226
 
                        draw_mode = 0;
227
 
        }
228
 
 
229
 
        // draw the segment
230
 
        switch( draw_mode ) {
231
 
        case 0: drawNextSegment_test( reset ); break;
232
 
        case 1: drawNextSegment_time( reset ); break;
233
 
        }
 
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
234
217
}
235
218
 
236
219
 
237
220
// calculate time constants when a new pulse has occurred
238
 
void calculateSegmentTimes()
 
221
void calculate_segment_times()
239
222
{
240
223
        // check for overflows, and only recalculate times if there isn't
241
224
        // one (if there is, we'll just go with the last pulse's times)
242
 
        if( new_pulse_at > last_pulse_at )
 
225
        if( _new_pulse_at > _last_pulse_at )
243
226
        {
244
227
                // new segment stepping times
245
 
                unsigned long delta = new_pulse_at - last_pulse_at;
246
 
                segment_step = delta / NUM_SEGMENTS;
247
 
                segment_step_sub = 0;
248
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
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;
249
232
        }
250
233
 
251
234
        // now we have dealt with this pulse, save the pulse time and
252
235
        // clear new_pulse_at, ready for the next pulse
253
 
        last_pulse_at = new_pulse_at;
254
 
        new_pulse_at = 0;
 
236
        _last_pulse_at = _new_pulse_at;
 
237
        _new_pulse_at = 0;
255
238
}
256
239
 
257
240
 
258
241
// wait until it is time to draw the next segment or a new pulse has
259
242
// occurred
260
 
void waitTillNextSegment( bool reset )
 
243
void wait_till_end_of_segment( bool reset )
261
244
{
262
245
        static unsigned long end_time = 0;
263
246
 
264
247
        // handle reset
265
248
        if( reset )
266
 
                end_time = last_pulse_at;
 
249
                end_time = _last_pulse_at;
267
250
 
268
251
        // work out the time that this segment should be displayed until
269
 
        end_time += segment_step;
270
 
        segment_step_sub += segment_step_sub_step;
271
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
272
 
                segment_step_sub -= NUM_SEGMENTS;
 
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;
273
256
                end_time++;
274
257
        }
275
258
 
276
259
        // wait
277
 
        while( micros() < end_time && !new_pulse_at );
 
260
        while( micros() < end_time && !_new_pulse_at );
278
261
}
279
262
 
280
263
 
281
264
// ISR to handle the pulses from the fan's tachiometer
282
 
void fanPulseHandler()
 
265
void fan_pulse_handler()
283
266
{
284
267
        // the fan actually sends two pulses per revolution. These pulses
285
268
        // may not be exactly evenly distributed around the rotation, so
290
273
        if( !ignore )
291
274
        {
292
275
                // set a new pulse time
293
 
                new_pulse_at = micros();
 
276
                _new_pulse_at = micros();
294
277
        }
295
278
}
296
279
 
299
282
void setup()
300
283
{
301
284
        // set up an interrupt handler on pin 2 to nitice fan pulses
302
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
285
        attachInterrupt( 0, fan_pulse_handler, RISING );
303
286
        digitalWrite( 2, HIGH );
304
287
  
305
288
        // set up output pins (4 to 13) for the led array
308
291
 
309
292
        // set up mode-switch button on pin 3
310
293
        pinMode( 3, INPUT );
311
 
 
312
 
        // get the time from the real-time clock
313
 
        int rtc_data[ 7 ];
314
 
        RTC.get( rtc_data, true );
315
 
        time_hours = rtc_data[ DS1307_HR ];
316
 
        time_minutes = rtc_data[ DS1307_MIN ];
317
 
        time_seconds = rtc_data[ DS1307_SEC ];
318
 
 
319
 
        // serial comms
320
 
        Serial.begin( 9600 );
 
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
        }
321
305
}
322
306
 
323
307
 
325
309
void loop()
326
310
{
327
311
        // if there has been a new pulse, we'll be resetting the display
328
 
        bool reset = new_pulse_at? true : false;
 
312
        bool reset = _new_pulse_at? true : false;
 
313
 
 
314
        // update button
 
315
        _button.update();
329
316
 
330
317
        // only do this stuff at the start of a display cycle, to ensure
331
318
        // that no state changes mid-display
332
319
        if( reset )
333
320
        {
334
 
                // check buttons
335
 
                checkButtons();
 
321
                // calculate segment times
 
322
                calculate_segment_times();
336
323
 
337
324
                // keep track of time
338
 
                trackTime();
 
325
                Time::update();
 
326
 
 
327
                // perform button events
 
328
                do_button_events();
339
329
        }
340
330
 
341
331
        // draw this segment
342
 
        drawNextSegment( reset );
343
 
 
344
 
        // do we need to recalculate segment times?
345
 
        if( reset )
346
 
                calculateSegmentTimes();
 
332
        draw_next_segment( reset );
347
333
 
348
334
        // wait till it's time to draw the next segment
349
 
        waitTillNextSegment( reset );
 
335
        wait_till_end_of_segment( reset );
350
336
}