/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"
85
 
#include "settings_mode.h"
86
 
#include "text.h"
87
 
#include "text_renderer.h"
88
 
#include "common.h"
 
77
 
 
78
#include <Bounce.h>
 
79
#include <DS1307.h>
 
80
#include <Wire.h>
89
81
 
90
82
//_____________________________________________________________________________
91
83
//                                                                         data
92
84
 
 
85
 
93
86
// when non-zero, the time (in microseconds) of a new fan pulse that
94
87
// has just occurred, which means that segment drawing needs to be
95
88
// restarted
96
 
static unsigned long _new_pulse_at = 0;
 
89
static unsigned long new_pulse_at = 0;
97
90
 
98
91
// the time (in microseconds) when the last fan pulse occurred
99
 
static unsigned long _last_pulse_at = 0;
 
92
static unsigned long last_pulse_at = 0;
100
93
 
101
94
// duration (in microseconds) that a segment should be displayed
102
 
static unsigned long _segment_step = 0;
 
95
static unsigned long segment_step = 0;
103
96
 
104
97
// remainder after divisor and a tally of the remainders for each segment
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
 
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 )
121
116
 
122
117
//_____________________________________________________________________________
123
118
//                                                                         code
124
119
 
125
120
 
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;
 
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;
198
158
                }
199
159
        }
200
160
}
201
161
 
202
162
 
203
 
// draw a display segment
204
 
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 )
205
180
{
206
181
        // keep track of segment
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
 
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
219
204
        if( reset ) {
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
 
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
        }
254
249
}
255
250
 
256
251
 
257
252
// calculate time constants when a new pulse has occurred
258
 
void calculate_segment_times()
 
253
void calculateSegmentTimes()
259
254
{
260
255
        // check for overflows, and only recalculate times if there isn't
261
256
        // one (if there is, we'll just go with the last pulse's times)
262
 
        if( _new_pulse_at > _last_pulse_at )
 
257
        if( new_pulse_at > last_pulse_at )
263
258
        {
264
259
                // new segment stepping times
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;
 
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;
269
264
        }
270
265
 
271
266
        // now we have dealt with this pulse, save the pulse time and
272
267
        // clear new_pulse_at, ready for the next pulse
273
 
        _last_pulse_at = _new_pulse_at;
274
 
        _new_pulse_at = 0;
 
268
        last_pulse_at = new_pulse_at;
 
269
        new_pulse_at = 0;
275
270
}
276
271
 
277
272
 
278
273
// wait until it is time to draw the next segment or a new pulse has
279
274
// occurred
280
 
void wait_till_end_of_segment( bool reset )
 
275
void waitTillNextSegment( bool reset )
281
276
{
282
277
        static unsigned long end_time = 0;
283
278
 
284
279
        // handle reset
285
280
        if( reset )
286
 
                end_time = _last_pulse_at;
 
281
                end_time = last_pulse_at;
287
282
 
288
283
        // work out the time that this segment should be displayed until
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;
 
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;
293
288
                end_time++;
294
289
        }
295
290
 
296
291
        // wait
297
 
        while( micros() < end_time && !_new_pulse_at );
 
292
        while( micros() < end_time && !new_pulse_at );
298
293
}
299
294
 
300
295
 
301
296
// ISR to handle the pulses from the fan's tachiometer
302
 
void fan_pulse_handler()
 
297
void fanPulseHandler()
303
298
{
304
299
        // the fan actually sends two pulses per revolution. These pulses
305
300
        // may not be exactly evenly distributed around the rotation, so
310
305
        if( !ignore )
311
306
        {
312
307
                // set a new pulse time
313
 
                _new_pulse_at = micros();
 
308
                new_pulse_at = micros();
314
309
        }
315
310
}
316
311
 
319
314
void setup()
320
315
{
321
316
        // set up an interrupt handler on pin 2 to nitice fan pulses
322
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
317
        attachInterrupt( 0, fanPulseHandler, RISING );
323
318
        digitalWrite( 2, HIGH );
324
319
  
325
320
        // set up output pins (4 to 13) for the led array
328
323
 
329
324
        // set up mode-switch button on pin 3
330
325
        pinMode( 3, INPUT );
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();
 
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 );
343
336
}
344
337
 
345
338
 
347
340
void loop()
348
341
{
349
342
        // if there has been a new pulse, we'll be resetting the display
350
 
        bool reset = _new_pulse_at? true : false;
351
 
 
352
 
        // update button
353
 
        _button.update();
 
343
        bool reset = new_pulse_at? true : false;
354
344
 
355
345
        // only do this stuff at the start of a display cycle, to ensure
356
346
        // that no state changes mid-display
357
347
        if( reset )
358
348
        {
359
 
                // calculate segment times
360
 
                calculate_segment_times();
 
349
                // check buttons
 
350
                checkButtons();
361
351
 
362
352
                // keep track of time
363
 
                Time::update();
364
 
 
365
 
                // perform button events
366
 
                do_button_events();
 
353
                trackTime();
367
354
        }
368
355
 
369
356
        // draw this segment
370
 
        draw_next_segment( reset );
 
357
        drawNextSegment( reset );
 
358
 
 
359
        // do we need to recalculate segment times?
 
360
        if( reset )
 
361
                calculateSegmentTimes();
371
362
 
372
363
        // wait till it's time to draw the next segment
373
 
        wait_till_end_of_segment( reset );
 
364
        waitTillNextSegment( reset );
374
365
}