/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-26 00:08:14 UTC
  • Revision ID: edam@waxworlds.org-20120126000814-tcoazbkb84e0s1wl
abstracted turning leds on/off to cope with PNP-inverted pin 4 and fixed warnings

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
1
 
/* -*- mode: c++; compile-command: "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/switcher_major_mode.h"
83
 
#include "modes/settings_major_mode.h"
84
 
#include "modes/analogue_clock_mode.h"
85
 
#include "modes/digital_clock_mode.h"
86
 
#include "modes/info_mode.h"
87
 
#include "modes/test_pattern_mode.h"
88
 
#include "text.h"
89
 
#include "text_renderer.h"
90
 
#include "common.h"
 
77
 
 
78
#include <Bounce.h>
 
79
#include <DS1307.h>
 
80
#include <Wire.h>
91
81
 
92
82
//_____________________________________________________________________________
93
83
//                                                                         data
94
84
 
 
85
 
95
86
// when non-zero, the time (in microseconds) of a new fan pulse that
96
87
// has just occurred, which means that segment drawing needs to be
97
88
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
89
static unsigned long new_pulse_at = 0;
99
90
 
100
91
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
92
static unsigned long last_pulse_at = 0;
102
93
 
103
94
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
95
static unsigned long segment_step = 0;
105
96
 
106
97
// remainder after divisor and a tally of the remainders for each segment
107
 
static unsigned long _segment_step_sub_step = 0;
108
 
static unsigned long _segment_step_sub = 0;
109
 
 
110
 
// the button
111
 
static Button _button( 3 );
112
 
 
113
 
// major modes
114
 
static MajorMode *_modes[ 3 ];
115
 
 
116
 
// current major mode
117
 
static int _mode = 0;
118
 
 
119
 
// interupt handler's "ignore every other" flag
120
 
static bool _pulse_ignore = true;
 
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
 
// perform button events
126
 
void do_button_events()
127
 
{
128
 
        // loop through pending events
129
 
        while( int event = _button.get_event() )
130
 
        {
131
 
                switch( event )
132
 
                {
133
 
                case 1:
134
 
                        // short press
135
 
                        _modes[ _mode ]->press();
136
 
                        break;
137
 
                case 2:
138
 
                        // long press
139
 
                        _modes[ _mode ]->long_press();
140
 
                        break;
141
 
                case 3:
142
 
                        // looooong press (change major mode)
143
 
                        _modes[ _mode ]->deactivate();
144
 
                        if( !_modes[ ++_mode ] ) _mode = 0;
145
 
                        _modes[ _mode ]->activate();
146
 
                        break;
147
 
                case 4:
148
 
                        // switch display upside-down
149
 
                        _pulse_ignore = !_pulse_ignore;
150
 
                        break;
 
120
 
 
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;
151
158
                }
152
159
        }
153
160
}
154
161
 
155
162
 
156
 
// draw a display segment
157
 
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 )
158
180
{
159
181
        // 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;
160
201
        static int segment = 0;
161
 
#if CLOCK_FORWARD
162
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
163
 
#else
164
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
165
 
#endif
166
 
 
167
 
        // reset the text renderer's buffer
168
 
        TextRenderer::reset_buffer();
169
 
 
170
 
        if( reset )
171
 
        {
172
 
                _modes[ _mode ]->draw_reset();
173
 
 
174
 
                // tell the text services we're starting a new frame
175
 
                Text::draw_reset();
176
 
        }
177
 
 
178
 
        // draw
179
 
        _modes[ _mode ]->draw( segment );
180
 
 
181
 
        // draw text
182
 
        Text::draw( segment );
183
 
 
184
 
        // draw text rednerer's buffer
185
 
        TextRenderer::output_buffer();
186
 
 
187
 
#if CLOCK_FORWARD
188
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
189
 
#else
190
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
191
 
#endif
 
202
 
 
203
        // handle display reset
 
204
        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
        }
192
249
}
193
250
 
194
251
 
195
252
// calculate time constants when a new pulse has occurred
196
 
void calculate_segment_times()
 
253
void calculateSegmentTimes()
197
254
{
198
255
        // check for overflows, and only recalculate times if there isn't
199
256
        // one (if there is, we'll just go with the last pulse's times)
200
 
        if( _new_pulse_at > _last_pulse_at )
 
257
        if( new_pulse_at > last_pulse_at )
201
258
        {
202
259
                // new segment stepping times
203
 
                unsigned long delta = _new_pulse_at - _last_pulse_at;
204
 
                _segment_step = delta / NUM_SEGMENTS;
205
 
                _segment_step_sub = 0;
206
 
                _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;
207
264
        }
208
265
 
209
266
        // now we have dealt with this pulse, save the pulse time and
210
267
        // clear new_pulse_at, ready for the next pulse
211
 
        _last_pulse_at = _new_pulse_at;
212
 
        _new_pulse_at = 0;
 
268
        last_pulse_at = new_pulse_at;
 
269
        new_pulse_at = 0;
213
270
}
214
271
 
215
272
 
216
273
// wait until it is time to draw the next segment or a new pulse has
217
274
// occurred
218
 
void wait_till_end_of_segment( bool reset )
 
275
void waitTillNextSegment( bool reset )
219
276
{
220
277
        static unsigned long end_time = 0;
221
278
 
222
279
        // handle reset
223
280
        if( reset )
224
 
                end_time = _last_pulse_at;
 
281
                end_time = last_pulse_at;
225
282
 
226
283
        // work out the time that this segment should be displayed until
227
 
        end_time += _segment_step;
228
 
        _segment_step_sub += _segment_step_sub_step;
229
 
        if( _segment_step_sub >= NUM_SEGMENTS ) {
230
 
                _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;
231
288
                end_time++;
232
289
        }
233
290
 
234
291
        // wait
235
 
        while( micros() < end_time && !_new_pulse_at );
 
292
        while( micros() < end_time && !new_pulse_at );
236
293
}
237
294
 
238
295
 
239
 
// ISR to handle the pulses from the fan's tachometer
240
 
void fan_pulse_handler()
 
296
// ISR to handle the pulses from the fan's tachiometer
 
297
void fanPulseHandler()
241
298
{
242
299
        // the fan actually sends two pulses per revolution. These pulses
243
300
        // may not be exactly evenly distributed around the rotation, so
244
301
        // we can't recalculate times on every pulse. Instead, we ignore
245
302
        // every other pulse so timings are based on a complete rotation.
246
 
        _pulse_ignore = !_pulse_ignore;
247
 
        if( !_pulse_ignore )
 
303
        static bool ignore = true;
 
304
        ignore = !ignore;
 
305
        if( !ignore )
248
306
        {
249
307
                // set a new pulse time
250
 
                _new_pulse_at = micros();
 
308
                new_pulse_at = micros();
251
309
        }
252
310
}
253
311
 
255
313
// main setup
256
314
void setup()
257
315
{
258
 
        // set up an interrupt handler on pin 2 to notice fan pulses
259
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
316
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
317
        attachInterrupt( 0, fanPulseHandler, RISING );
260
318
        digitalWrite( 2, HIGH );
261
319
  
262
320
        // set up output pins (4 to 13) for the led array
265
323
 
266
324
        // set up mode-switch button on pin 3
267
325
        pinMode( 3, INPUT );
268
 
        digitalWrite( 3, HIGH );
269
 
        static int event_times[] = { 10, 500, 2000, 4000, 0 };
270
 
        _button.set_event_times( event_times );
271
 
 
272
 
        // initialise RTC
273
 
        Time::load_time();
274
 
 
275
 
        // init text renderer
276
 
        TextRenderer::init();
277
 
 
278
 
        // reset text
279
 
        Text::reset();
280
 
        leds_off();
281
 
 
282
 
        static SwitcherMajorMode switcher;
283
 
        static SettingsMajorMode settings( _button );
284
 
 
285
 
        // add major modes
286
 
        int mode = 0;
287
 
        _modes[ mode++ ] = &switcher;
288
 
        _modes[ mode++ ] = &settings;
289
 
        _modes[ mode ] = 0;
290
 
 
291
 
        // activate the current major mode
292
 
        _modes[ _mode ]->activate();
 
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 );
293
336
}
294
337
 
295
338
 
297
340
void loop()
298
341
{
299
342
        // if there has been a new pulse, we'll be resetting the display
300
 
        bool reset = _new_pulse_at? true : false;
301
 
 
302
 
        // update button
303
 
        _button.update();
 
343
        bool reset = new_pulse_at? true : false;
304
344
 
305
345
        // only do this stuff at the start of a display cycle, to ensure
306
346
        // that no state changes mid-display
307
347
        if( reset )
308
348
        {
309
 
                // calculate segment times
310
 
                calculate_segment_times();
 
349
                // check buttons
 
350
                checkButtons();
311
351
 
312
352
                // keep track of time
313
 
                Time::update();
314
 
 
315
 
                // perform button events
316
 
                do_button_events();
 
353
                trackTime();
317
354
        }
318
355
 
319
356
        // draw this segment
320
 
        draw_next_segment( reset );
 
357
        drawNextSegment( reset );
 
358
 
 
359
        // do we need to recalculate segment times?
 
360
        if( reset )
 
361
                calculateSegmentTimes();
321
362
 
322
363
        // wait till it's time to draw the next segment
323
 
        wait_till_end_of_segment( reset );
 
364
        waitTillNextSegment( reset );
324
365
}