/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-01-14 17:31:00 UTC
  • Revision ID: edam@waxworlds.org-20120114173100-6gt6jte0j40cchj8
initialise from real-time clock; updated Makefile

Show diffs side-by-side

added added

removed removed

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