/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

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 )
 
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 )
121
123
 
122
124
//_____________________________________________________________________________
123
125
//                                                                         code
124
126
 
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;
 
127
 
 
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;
151
165
                }
152
166
        }
153
167
}
154
168
 
155
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
 
156
223
// draw a display segment
157
 
void draw_next_segment( bool reset )
 
224
void drawNextSegment( bool reset )
158
225
{
 
226
        static int draw_mode = 0;
 
227
 
159
228
        // keep track of segment
160
 
        static int segment = 0;
161
229
#if CLOCK_FORWARD
 
230
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
162
231
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
163
232
#else
 
233
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
164
234
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
165
235
#endif
166
236
 
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();
 
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
        }
186
250
 
187
251
#if CLOCK_FORWARD
188
252
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
193
257
 
194
258
 
195
259
// calculate time constants when a new pulse has occurred
196
 
void calculate_segment_times()
 
260
void calculateSegmentTimes()
197
261
{
198
262
        // check for overflows, and only recalculate times if there isn't
199
263
        // one (if there is, we'll just go with the last pulse's times)
200
 
        if( _new_pulse_at > _last_pulse_at )
 
264
        if( new_pulse_at > last_pulse_at )
201
265
        {
202
266
                // 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;
 
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;
207
271
        }
208
272
 
209
273
        // now we have dealt with this pulse, save the pulse time and
210
274
        // clear new_pulse_at, ready for the next pulse
211
 
        _last_pulse_at = _new_pulse_at;
212
 
        _new_pulse_at = 0;
 
275
        last_pulse_at = new_pulse_at;
 
276
        new_pulse_at = 0;
213
277
}
214
278
 
215
279
 
216
280
// wait until it is time to draw the next segment or a new pulse has
217
281
// occurred
218
 
void wait_till_end_of_segment( bool reset )
 
282
void waitTillNextSegment( bool reset )
219
283
{
220
284
        static unsigned long end_time = 0;
221
285
 
222
286
        // handle reset
223
287
        if( reset )
224
 
                end_time = _last_pulse_at;
 
288
                end_time = last_pulse_at;
225
289
 
226
290
        // 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;
 
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;
231
295
                end_time++;
232
296
        }
233
297
 
234
298
        // wait
235
 
        while( micros() < end_time && !_new_pulse_at );
 
299
        while( micros() < end_time && !new_pulse_at );
236
300
}
237
301
 
238
302
 
239
 
// ISR to handle the pulses from the fan's tachometer
240
 
void fan_pulse_handler()
 
303
// ISR to handle the pulses from the fan's tachiometer
 
304
void fanPulseHandler()
241
305
{
242
306
        // the fan actually sends two pulses per revolution. These pulses
243
307
        // may not be exactly evenly distributed around the rotation, so
244
308
        // we can't recalculate times on every pulse. Instead, we ignore
245
309
        // every other pulse so timings are based on a complete rotation.
246
 
        _pulse_ignore = !_pulse_ignore;
247
 
        if( !_pulse_ignore )
 
310
        static bool ignore = true;
 
311
        ignore = !ignore;
 
312
        if( !ignore )
248
313
        {
249
314
                // set a new pulse time
250
 
                _new_pulse_at = micros();
 
315
                new_pulse_at = micros();
251
316
        }
252
317
}
253
318
 
255
320
// main setup
256
321
void setup()
257
322
{
258
 
        // set up an interrupt handler on pin 2 to notice fan pulses
259
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
323
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
324
        attachInterrupt( 0, fanPulseHandler, RISING );
260
325
        digitalWrite( 2, HIGH );
261
326
  
262
327
        // set up output pins (4 to 13) for the led array
266
331
        // set up mode-switch button on pin 3
267
332
        pinMode( 3, INPUT );
268
333
        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();
 
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 );
293
344
}
294
345
 
295
346
 
297
348
void loop()
298
349
{
299
350
        // 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();
 
351
        bool reset = new_pulse_at? true : false;
304
352
 
305
353
        // only do this stuff at the start of a display cycle, to ensure
306
354
        // that no state changes mid-display
307
355
        if( reset )
308
356
        {
309
 
                // calculate segment times
310
 
                calculate_segment_times();
 
357
                // check buttons
 
358
                checkButtons();
311
359
 
312
360
                // keep track of time
313
 
                Time::update();
314
 
 
315
 
                // perform button events
316
 
                do_button_events();
 
361
                trackTime();
317
362
        }
318
363
 
319
364
        // draw this segment
320
 
        draw_next_segment( reset );
 
365
        drawNextSegment( reset );
 
366
 
 
367
        // do we need to recalculate segment times?
 
368
        if( reset )
 
369
                calculateSegmentTimes();
321
370
 
322
371
        // wait till it's time to draw the next segment
323
 
        wait_till_end_of_segment( reset );
 
372
        waitTillNextSegment( reset );
324
373
}