/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-23 20:18:22 UTC
  • Revision ID: edam@waxworlds.org-20120223201822-dno5n4fwvd35izq9
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand

Show diffs side-by-side

added added

removed removed

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