/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:13:13 UTC
  • Revision ID: edam@waxworlds.org-20120216001313-5w52cnns4cqofb6e
updated arduino.mk

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
 
2
/*
 
3
 * propeller-clock.ino
 
4
 *
 
5
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
6
 *
 
7
 * This file is part of propeller-clock (hereafter referred to as "this
 
8
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
9
 * information.
 
10
 *
 
11
 * This program is free software: you can redistribute it and/or modify
 
12
 * it under the terms of the GNU Lesser General Public License as published
 
13
 * by the Free Software Foundation, either version 3 of the License, or
 
14
 * (at your option) any later version.
 
15
 *
 
16
 * This program is distributed in the hope that it will be useful,
 
17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
19
 * GNU Lesser General Public License for more details.
 
20
 *
 
21
 * You should have received a copy of the GNU Lesser General Public License
 
22
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
23
 */
 
24
 
 
25
/******************************************************************************
 
26
 
 
27
Set up:
 
28
 
 
29
 * a PC fan is wired up to a 12V power supply
 
30
 
 
31
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
 
32
   arduino.
 
33
 
 
34
 * the pins 4 to 13 on the arduino should directly drive an LED (the
 
35
   LED on pin 4 is in the centre of the clock face and the LED on pin
 
36
   13 is at the outside.
 
37
 
 
38
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
 
39
   used to indirectly drive a transistor which in turn drives several
 
40
   LEDs that turn on anf off in unison in the centre of the clock.
 
41
 
 
42
 * a button should be attached to pin 3 that grounds it when pressed.
 
43
 
 
44
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
 
45
 
 
46
Implementation details:
 
47
 
 
48
 * for a schematic, see ../project/propeller-clock.sch.
 
49
 
 
50
 * the timing of the drawing of the clock face is recalculated with
 
51
   every rotation of the propeller.
 
52
    
 
53
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
 
54
   software skips every other one. This means that the clock may
 
55
   appear upside-down if started with the propeller in the wrong
 
56
   position. You will need to experiment to dicsover the position that
 
57
   the propeller must be in when starting the clock.
 
58
    
 
59
Usage instructions:
 
60
 
 
61
 * pressing the button cycles between variations of the current
 
62
   display mode.
 
63
  
 
64
 * pressing and holding the button for a second cycles between display
 
65
   modes (e.g., analogue and digital).
 
66
 
 
67
 * pressing and holding the button for 5 seconds enters "time set"
 
68
   mode. In this mode, the following applies:
 
69
    - the field that is being set flashes
 
70
    - pressing the button increments the field currently being set
 
71
    - pressing and holding the button for a second cycles through the
 
72
      fields that can be set
 
73
    - pressing and holding the button for 5 seconds sets the time and
 
74
      exits "time set" mode
 
75
 
 
76
******************************************************************************/
 
77
 
 
78
 
 
79
#include <Bounce.h>
 
80
#include <DS1307.h>
 
81
#include <Wire.h>
 
82
 
 
83
//_____________________________________________________________________________
 
84
//                                                                         data
 
85
 
 
86
 
 
87
// when non-zero, the time (in microseconds) of a new fan pulse that
 
88
// has just occurred, which means that segment drawing needs to be
 
89
// restarted
 
90
static unsigned long new_pulse_at = 0;
 
91
 
 
92
// the time (in microseconds) when the last fan pulse occurred
 
93
static unsigned long last_pulse_at = 0;
 
94
 
 
95
// duration (in microseconds) that a segment should be displayed
 
96
static unsigned long segment_step = 0;
 
97
 
 
98
// remainder after divisor and a tally of the remainders for each segment
 
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
//_____________________________________________________________________________
 
119
//                                                                         code
 
120
 
 
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;
 
159
                }
 
160
        }
 
161
}
 
162
 
 
163
 
 
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 )
 
182
{
 
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;
 
203
        static int segment = 0;
 
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
        }
 
251
}
 
252
 
 
253
 
 
254
// calculate time constants when a new pulse has occurred
 
255
void calculateSegmentTimes()
 
256
{
 
257
        // check for overflows, and only recalculate times if there isn't
 
258
        // one (if there is, we'll just go with the last pulse's times)
 
259
        if( new_pulse_at > last_pulse_at )
 
260
        {
 
261
                // new segment stepping times
 
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;
 
266
        }
 
267
 
 
268
        // now we have dealt with this pulse, save the pulse time and
 
269
        // clear new_pulse_at, ready for the next pulse
 
270
        last_pulse_at = new_pulse_at;
 
271
        new_pulse_at = 0;
 
272
}
 
273
 
 
274
 
 
275
// wait until it is time to draw the next segment or a new pulse has
 
276
// occurred
 
277
void waitTillNextSegment( bool reset )
 
278
{
 
279
        static unsigned long end_time = 0;
 
280
 
 
281
        // handle reset
 
282
        if( reset )
 
283
                end_time = last_pulse_at;
 
284
 
 
285
        // work out the time that this segment should be displayed until
 
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;
 
290
                end_time++;
 
291
        }
 
292
 
 
293
        // wait
 
294
        while( micros() < end_time && !new_pulse_at );
 
295
}
 
296
 
 
297
 
 
298
// ISR to handle the pulses from the fan's tachiometer
 
299
void fanPulseHandler()
 
300
{
 
301
        // the fan actually sends two pulses per revolution. These pulses
 
302
        // may not be exactly evenly distributed around the rotation, so
 
303
        // we can't recalculate times on every pulse. Instead, we ignore
 
304
        // every other pulse so timings are based on a complete rotation.
 
305
        static bool ignore = true;
 
306
        ignore = !ignore;
 
307
        if( !ignore )
 
308
        {
 
309
                // set a new pulse time
 
310
                new_pulse_at = micros();
 
311
        }
 
312
}
 
313
 
 
314
 
 
315
// main setup
 
316
void setup()
 
317
{
 
318
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
319
        attachInterrupt( 0, fanPulseHandler, RISING );
 
320
        digitalWrite( 2, HIGH );
 
321
  
 
322
        // set up output pins (4 to 13) for the led array
 
323
        for( int a = 4; a < 14; a++ )
 
324
                pinMode( a, OUTPUT );
 
325
 
 
326
        // set up mode-switch button on pin 3
 
327
        pinMode( 3, INPUT );
 
328
        digitalWrite( 3, HIGH );
 
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 );
 
339
}
 
340
 
 
341
 
 
342
// main loop
 
343
void loop()
 
344
{
 
345
        // if there has been a new pulse, we'll be resetting the display
 
346
        bool reset = new_pulse_at? true : false;
 
347
 
 
348
        // only do this stuff at the start of a display cycle, to ensure
 
349
        // that no state changes mid-display
 
350
        if( reset )
 
351
        {
 
352
                // check buttons
 
353
                checkButtons();
 
354
 
 
355
                // keep track of time
 
356
                trackTime();
 
357
        }
 
358
 
 
359
        // draw this segment
 
360
        drawNextSegment( reset );
 
361
 
 
362
        // do we need to recalculate segment times?
 
363
        if( reset )
 
364
                calculateSegmentTimes();
 
365
 
 
366
        // wait till it's time to draw the next segment
 
367
        waitTillNextSegment( reset );
 
368
}