/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: 2011-11-04 00:49:57 UTC
  • Revision ID: edam@waxworlds.org-20111104004957-6lv2138atk3y3519
added electronics info and (unfinished) scematic and changed Notes to
be a text file

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