/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-21 21:24:17 UTC
  • Revision ID: tim@ed.am-20120321212417-dnba5l1oheddeyxw
fixed time centring and display in settings mode

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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"
 
85
#include "settings_mode.h"
 
86
#include "text.h"
 
87
#include "text_renderer.h"
 
88
#include "common.h"
81
89
 
82
90
//_____________________________________________________________________________
83
91
//                                                                         data
84
92
 
85
 
 
86
93
// when non-zero, the time (in microseconds) of a new fan pulse that
87
94
// has just occurred, which means that segment drawing needs to be
88
95
// restarted
89
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
90
97
 
91
98
// the time (in microseconds) when the last fan pulse occurred
92
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
93
100
 
94
101
// duration (in microseconds) that a segment should be displayed
95
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
96
103
 
97
104
// 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, 50 );
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 )
 
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
116
121
 
117
122
//_____________________________________________________________________________
118
123
//                                                                         code
119
124
 
120
125
 
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;
 
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
        // give the mode a chance to init
 
149
        switch( _major_mode ) {
 
150
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
151
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
 
152
        }
 
153
}
 
154
 
 
155
 
 
156
// perform button events
 
157
void do_button_events()
 
158
{
 
159
        // loop through pending events
 
160
        while( int event = _button.get_event() )
 
161
        {
 
162
                switch( event )
 
163
                {
 
164
                case 1:
 
165
                        // short press
 
166
                        switch( _major_mode ) {
 
167
                        case MAIN_MODE_IDX:
 
168
                                switch( _minor_mode ) {
 
169
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
170
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
171
                                }
 
172
                                break;
 
173
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
 
174
                        }
 
175
                        break;
 
176
 
 
177
                case 2:
 
178
                        // long press
 
179
                        switch( _major_mode ) {
 
180
                        case MAIN_MODE_IDX:
 
181
                                if( ++_minor_mode >= 3 )
 
182
                                        _minor_mode = 0;
 
183
                                activate_minor_mode();
 
184
                                break;
 
185
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
 
186
                        }
 
187
                        break;
 
188
 
 
189
                case 3:
 
190
                        // looooong press (change major mode)
 
191
                        if( ++_major_mode > 1 )
 
192
                                _major_mode = 0;
 
193
                        activate_major_mode();
 
194
                        break;
158
195
                }
159
196
        }
160
197
}
161
198
 
162
199
 
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 )
 
200
// draw a display segment
 
201
void draw_next_segment( bool reset )
180
202
{
181
203
        // keep track of segment
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
 
204
#if CLOCK_FORWARD
 
205
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
206
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
207
#else
 
208
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
209
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
210
#endif
 
211
 
 
212
        // reset the text renderer
 
213
        TextRenderer::reset_buffer();
 
214
 
 
215
        // frame reset
204
216
        if( reset ) {
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
                switch( _major_mode ) {
 
218
                case MAIN_MODE_IDX:
 
219
                        switch( _minor_mode ) {
 
220
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
221
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
222
                        }
 
223
                        break;
 
224
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
 
225
                }
 
226
 
 
227
                // tell the text services we're starting a new frame
 
228
                Text::draw_reset();
 
229
        }
 
230
 
 
231
        // draw
 
232
        switch( _major_mode ) {
 
233
        case MAIN_MODE_IDX:
 
234
                switch( _minor_mode ) {
 
235
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
236
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
237
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
238
                }
 
239
                break;
 
240
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
 
241
        }
 
242
 
 
243
        // draw any text that was rendered
 
244
        TextRenderer::output_buffer();
 
245
 
 
246
#if CLOCK_FORWARD
 
247
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
248
#else
 
249
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
250
#endif
249
251
}
250
252
 
251
253
 
252
254
// calculate time constants when a new pulse has occurred
253
 
void calculateSegmentTimes()
 
255
void calculate_segment_times()
254
256
{
255
257
        // check for overflows, and only recalculate times if there isn't
256
258
        // one (if there is, we'll just go with the last pulse's times)
257
 
        if( new_pulse_at > last_pulse_at )
 
259
        if( _new_pulse_at > _last_pulse_at )
258
260
        {
259
261
                // new segment stepping times
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;
 
262
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
263
                _segment_step = delta / NUM_SEGMENTS;
 
264
                _segment_step_sub = 0;
 
265
                _segment_step_sub_step = delta % NUM_SEGMENTS;
264
266
        }
265
267
 
266
268
        // now we have dealt with this pulse, save the pulse time and
267
269
        // clear new_pulse_at, ready for the next pulse
268
 
        last_pulse_at = new_pulse_at;
269
 
        new_pulse_at = 0;
 
270
        _last_pulse_at = _new_pulse_at;
 
271
        _new_pulse_at = 0;
270
272
}
271
273
 
272
274
 
273
275
// wait until it is time to draw the next segment or a new pulse has
274
276
// occurred
275
 
void waitTillNextSegment( bool reset )
 
277
void wait_till_end_of_segment( bool reset )
276
278
{
277
279
        static unsigned long end_time = 0;
278
280
 
279
281
        // handle reset
280
282
        if( reset )
281
 
                end_time = last_pulse_at;
 
283
                end_time = _last_pulse_at;
282
284
 
283
285
        // work out the time that this segment should be displayed until
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;
 
286
        end_time += _segment_step;
 
287
        _segment_step_sub += _segment_step_sub_step;
 
288
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
289
                _segment_step_sub -= NUM_SEGMENTS;
288
290
                end_time++;
289
291
        }
290
292
 
291
293
        // wait
292
 
        while( micros() < end_time && !new_pulse_at );
 
294
        while( micros() < end_time && !_new_pulse_at );
293
295
}
294
296
 
295
297
 
296
298
// ISR to handle the pulses from the fan's tachiometer
297
 
void fanPulseHandler()
 
299
void fan_pulse_handler()
298
300
{
299
301
        // the fan actually sends two pulses per revolution. These pulses
300
302
        // may not be exactly evenly distributed around the rotation, so
305
307
        if( !ignore )
306
308
        {
307
309
                // set a new pulse time
308
 
                new_pulse_at = micros();
 
310
                _new_pulse_at = micros();
309
311
        }
310
312
}
311
313
 
314
316
void setup()
315
317
{
316
318
        // set up an interrupt handler on pin 2 to nitice fan pulses
317
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
319
        attachInterrupt( 0, fan_pulse_handler, RISING );
318
320
        digitalWrite( 2, HIGH );
319
321
  
320
322
        // set up output pins (4 to 13) for the led array
324
326
        // set up mode-switch button on pin 3
325
327
        pinMode( 3, INPUT );
326
328
        digitalWrite( 3, HIGH );
327
 
 
328
 
        // get the time from the real-time clock
329
 
        int rtc_data[ 7 ];
330
 
        RTC.get( rtc_data, true );
331
 
        time_hours = rtc_data[ DS1307_HR ];
332
 
        time_minutes = rtc_data[ DS1307_MIN ];
333
 
        time_seconds = rtc_data[ DS1307_SEC ];
334
 
 
335
 
        // serial comms
336
 
        Serial.begin( 9600 );
 
329
        static int event_times[] = { 5, 500, 4000, 0 };
 
330
        _button.set_event_times( event_times );
 
331
 
 
332
        // initialise RTC
 
333
        Time::init();
 
334
 
 
335
        // activate the minor mode
 
336
        activate_major_mode();
337
337
}
338
338
 
339
339
 
341
341
void loop()
342
342
{
343
343
        // if there has been a new pulse, we'll be resetting the display
344
 
        bool reset = new_pulse_at? true : false;
 
344
        bool reset = _new_pulse_at? true : false;
 
345
 
 
346
        // update button
 
347
        _button.update();
345
348
 
346
349
        // only do this stuff at the start of a display cycle, to ensure
347
350
        // that no state changes mid-display
348
351
        if( reset )
349
352
        {
350
 
                // check buttons
351
 
                checkButtons();
 
353
                // calculate segment times
 
354
                calculate_segment_times();
352
355
 
353
356
                // keep track of time
354
 
                trackTime();
 
357
                Time::update();
 
358
 
 
359
                // perform button events
 
360
                do_button_events();
355
361
        }
356
362
 
357
363
        // draw this segment
358
 
        drawNextSegment( reset );
359
 
 
360
 
        // do we need to recalculate segment times?
361
 
        if( reset )
362
 
                calculateSegmentTimes();
 
364
        draw_next_segment( reset );
363
365
 
364
366
        // wait till it's time to draw the next segment
365
 
        waitTillNextSegment( reset );
 
367
        wait_till_end_of_segment( reset );
366
368
}