/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-16 00:08:37 UTC
  • Revision ID: edam@waxworlds.org-20120216000837-ozbyl61w2n2thwa0
update arduino.mk

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
1
 
/* -*- mode: c++; compile-command: "make"; -*- */
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
2
/*
3
3
 * propeller-clock.ino
4
4
 *
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/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"
 
78
 
 
79
#include <Bounce.h>
 
80
#include <DS1307.h>
 
81
#include <Wire.h>
91
82
 
92
83
//_____________________________________________________________________________
93
84
//                                                                         data
94
85
 
 
86
 
95
87
// when non-zero, the time (in microseconds) of a new fan pulse that
96
88
// has just occurred, which means that segment drawing needs to be
97
89
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
90
static unsigned long new_pulse_at = 0;
99
91
 
100
92
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
93
static unsigned long last_pulse_at = 0;
102
94
 
103
95
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
96
static unsigned long segment_step = 0;
105
97
 
106
98
// 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;
 
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 )
121
117
 
122
118
//_____________________________________________________________________________
123
119
//                                                                         code
124
120
 
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;
 
121
 
 
122
// check for button presses
 
123
void checkButtons()
 
124
{
 
125
        // update buttons
 
126
        button.update();
 
127
 
 
128
        // notice button presses
 
129
        if( button.risingEdge() )
 
130
                inc_draw_mode = true;
 
131
}
 
132
 
 
133
 
 
134
// keep track of time
 
135
void trackTime()
 
136
{
 
137
        // previous time and any carried-over milliseconds
 
138
        static unsigned long last_time = millis();
 
139
        static unsigned long carry = 0;
 
140
 
 
141
        // how many milliseonds have elapsed since we last checked?
 
142
        unsigned long next_time = millis();
 
143
        unsigned long delta = next_time - last_time + carry;
 
144
 
 
145
        // update the previous time and carried-over milliseconds
 
146
        last_time = next_time;
 
147
        carry = delta % 1000;
 
148
 
 
149
        // add the seconds that have passed to the time
 
150
        time_seconds += delta / 1000;
 
151
        while( time_seconds >= 60 ) {
 
152
                time_seconds -= 60;
 
153
                time_minutes++;
 
154
                if( time_minutes >= 60 ) {
 
155
                        time_minutes -= 60;
 
156
                        time_hours++;
 
157
                        if( time_hours >= 24 )
 
158
                                time_hours -= 24;
151
159
                }
152
160
        }
153
161
}
154
162
 
155
163
 
156
 
// draw a display segment
157
 
void draw_next_segment( bool reset )
 
164
// turn an led on/off
 
165
void ledOn( int num, bool on )
 
166
{
 
167
        if( num < 0 || num > 9 ) return;
 
168
 
 
169
        // convert to pin no.
 
170
        num += 4;
 
171
 
 
172
        // pin 4 needs to be inverted (it's driving a PNP)
 
173
        // NOTE: PIN 4 TEMPORARILY DISABLED
 
174
        if( num == 4 ) on = true; //!on
 
175
 
 
176
        digitalWrite( num, on? HIGH : LOW );
 
177
}
 
178
 
 
179
 
 
180
// draw a segment for the test display
 
181
void drawNextSegment_test( bool reset )
158
182
{
159
183
        // keep track of segment
 
184
        static unsigned int segment = 0;
 
185
        if( reset ) segment = 0;
 
186
        segment++;
 
187
 
 
188
        // turn on inside and outside LEDs
 
189
        ledOn( 0, true );
 
190
        ledOn( 9, true );
 
191
 
 
192
        // display segment number in binary across in the inside LEDs,
 
193
        // with the LED on pin 12 showing the least-significant bit
 
194
        for( int a = 0; a < 8; a++ )
 
195
                ledOn( 8 - a, ( segment >> a ) & 1 );
 
196
}
 
197
 
 
198
 
 
199
// draw a segment for the time display
 
200
void drawNextSegment_time( bool reset )
 
201
{
 
202
        static int second = 0;
160
203
        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
 
204
 
 
205
        // handle display reset
 
206
        if( reset ) {
 
207
                second = 0;
 
208
                segment = 0;
 
209
        }
 
210
 
 
211
        // what needs to be drawn?
 
212
        bool draw_tick = !segment && second % 5 == 0;
 
213
        bool draw_second = !segment && second == time_seconds;
 
214
        bool draw_minute = !segment && second == time_minutes;
 
215
        bool draw_hour = !segment && second == time_hours;
 
216
 
 
217
        // set the LEDs
 
218
        ledOn( 9, true );
 
219
        ledOn( 8, draw_tick || draw_minute );
 
220
        for( int a = 6; a <= 7; a++ )
 
221
                ledOn( a, draw_minute || draw_second );
 
222
        for( int a = 0; a <= 5; a++ )
 
223
                ledOn( a, draw_minute || draw_second || draw_hour );
 
224
 
 
225
        // inc position
 
226
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
 
227
                segment = 0;
 
228
                second++;
 
229
        }
 
230
}
 
231
 
 
232
 
 
233
// draw a display segment
 
234
void drawNextSegment( bool reset )
 
235
{
 
236
        static int draw_mode = 0;
 
237
 
 
238
        // handle mode switch requests
 
239
        if( reset && inc_draw_mode ) {
 
240
                inc_draw_mode = false;
 
241
                draw_mode++;
 
242
                if( draw_mode >= 2 )
 
243
                        draw_mode = 0;
 
244
        }
 
245
 
 
246
        // draw the segment
 
247
        switch( draw_mode ) {
 
248
        case 0: drawNextSegment_test( reset ); break;
 
249
        case 1: drawNextSegment_time( reset ); break;
 
250
        }
192
251
}
193
252
 
194
253
 
195
254
// calculate time constants when a new pulse has occurred
196
 
void calculate_segment_times()
 
255
void calculateSegmentTimes()
197
256
{
198
257
        // check for overflows, and only recalculate times if there isn't
199
258
        // one (if there is, we'll just go with the last pulse's times)
200
 
        if( _new_pulse_at > _last_pulse_at )
 
259
        if( new_pulse_at > last_pulse_at )
201
260
        {
202
261
                // 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;
 
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;
207
266
        }
208
267
 
209
268
        // now we have dealt with this pulse, save the pulse time and
210
269
        // clear new_pulse_at, ready for the next pulse
211
 
        _last_pulse_at = _new_pulse_at;
212
 
        _new_pulse_at = 0;
 
270
        last_pulse_at = new_pulse_at;
 
271
        new_pulse_at = 0;
213
272
}
214
273
 
215
274
 
216
275
// wait until it is time to draw the next segment or a new pulse has
217
276
// occurred
218
 
void wait_till_end_of_segment( bool reset )
 
277
void waitTillNextSegment( bool reset )
219
278
{
220
279
        static unsigned long end_time = 0;
221
280
 
222
281
        // handle reset
223
282
        if( reset )
224
 
                end_time = _last_pulse_at;
 
283
                end_time = last_pulse_at;
225
284
 
226
285
        // 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;
 
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;
231
290
                end_time++;
232
291
        }
233
292
 
234
293
        // wait
235
 
        while( micros() < end_time && !_new_pulse_at );
 
294
        while( micros() < end_time && !new_pulse_at );
236
295
}
237
296
 
238
297
 
239
 
// ISR to handle the pulses from the fan's tachometer
240
 
void fan_pulse_handler()
 
298
// ISR to handle the pulses from the fan's tachiometer
 
299
void fanPulseHandler()
241
300
{
242
301
        // the fan actually sends two pulses per revolution. These pulses
243
302
        // may not be exactly evenly distributed around the rotation, so
244
303
        // we can't recalculate times on every pulse. Instead, we ignore
245
304
        // every other pulse so timings are based on a complete rotation.
246
 
        _pulse_ignore = !_pulse_ignore;
247
 
        if( !_pulse_ignore )
 
305
        static bool ignore = true;
 
306
        ignore = !ignore;
 
307
        if( !ignore )
248
308
        {
249
309
                // set a new pulse time
250
 
                _new_pulse_at = micros();
 
310
                new_pulse_at = micros();
251
311
        }
252
312
}
253
313
 
255
315
// main setup
256
316
void setup()
257
317
{
258
 
        // set up an interrupt handler on pin 2 to notice fan pulses
259
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
318
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
319
        attachInterrupt( 0, fanPulseHandler, RISING );
260
320
        digitalWrite( 2, HIGH );
261
321
  
262
322
        // set up output pins (4 to 13) for the led array
266
326
        // set up mode-switch button on pin 3
267
327
        pinMode( 3, INPUT );
268
328
        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();
 
329
 
 
330
        // get the time from the real-time clock
 
331
        int rtc_data[ 7 ];
 
332
        RTC.get( rtc_data, true );
 
333
        time_hours = rtc_data[ DS1307_HR ];
 
334
        time_minutes = rtc_data[ DS1307_MIN ];
 
335
        time_seconds = rtc_data[ DS1307_SEC ];
 
336
 
 
337
        // serial comms
 
338
        Serial.begin( 9600 );
293
339
}
294
340
 
295
341
 
297
343
void loop()
298
344
{
299
345
        // 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();
 
346
        bool reset = new_pulse_at? true : false;
304
347
 
305
348
        // only do this stuff at the start of a display cycle, to ensure
306
349
        // that no state changes mid-display
307
350
        if( reset )
308
351
        {
309
 
                // calculate segment times
310
 
                calculate_segment_times();
 
352
                // check buttons
 
353
                checkButtons();
311
354
 
312
355
                // keep track of time
313
 
                Time::update();
314
 
 
315
 
                // perform button events
316
 
                do_button_events();
 
356
                trackTime();
317
357
        }
318
358
 
319
359
        // draw this segment
320
 
        draw_next_segment( reset );
 
360
        drawNextSegment( reset );
 
361
 
 
362
        // do we need to recalculate segment times?
 
363
        if( reset )
 
364
                calculateSegmentTimes();
321
365
 
322
366
        // wait till it's time to draw the next segment
323
 
        wait_till_end_of_segment( reset );
 
367
        waitTillNextSegment( reset );
324
368
}