/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 15:07:26 UTC
  • Revision ID: edam@waxworlds.org-20111104150726-0evv5cetrckzg9do
cleaned-up info

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 draw direction
119
 
#define CLOCK_FORWARD 0
120
 
 
121
 
// rotate display (in segments)
122
 
#define CLOCK_SHIFT ( 58 * NUM_SECOND_SEGMENTS - 1 )
123
 
 
124
 
//_____________________________________________________________________________
125
 
//                                                                         code
126
 
 
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;
165
 
                }
166
 
        }
167
 
}
168
 
 
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
 
 
223
 
// draw a display segment
224
 
void drawNextSegment( bool reset )
225
 
{
226
 
        static int draw_mode = 0;
227
 
 
228
 
        // keep track of segment
229
 
#if CLOCK_FORWARD
230
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
231
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
232
 
#else
233
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
234
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
235
 
#endif
236
 
 
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
 
        }
250
 
 
251
 
#if CLOCK_FORWARD
252
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
253
 
#else
254
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
255
 
#endif
256
 
}
257
 
 
258
 
 
259
 
// calculate time constants when a new pulse has occurred
260
 
void calculateSegmentTimes()
261
 
{
262
 
        // check for overflows, and only recalculate times if there isn't
263
 
        // one (if there is, we'll just go with the last pulse's times)
264
 
        if( new_pulse_at > last_pulse_at )
265
 
        {
266
 
                // new segment stepping times
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;
271
 
        }
272
 
 
273
 
        // now we have dealt with this pulse, save the pulse time and
274
 
        // clear new_pulse_at, ready for the next pulse
275
 
        last_pulse_at = new_pulse_at;
276
 
        new_pulse_at = 0;
277
 
}
278
 
 
279
 
 
280
 
// wait until it is time to draw the next segment or a new pulse has
281
 
// occurred
282
 
void waitTillNextSegment( bool reset )
283
 
{
284
 
        static unsigned long end_time = 0;
285
 
 
286
 
        // handle reset
287
 
        if( reset )
288
 
                end_time = last_pulse_at;
289
 
 
290
 
        // work out the time that this segment should be displayed until
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;
295
 
                end_time++;
296
 
        }
297
 
 
298
 
        // wait
299
 
        while( micros() < end_time && !new_pulse_at );
300
 
}
301
 
 
302
 
 
303
 
// ISR to handle the pulses from the fan's tachiometer
304
 
void fanPulseHandler()
305
 
{
306
 
        // the fan actually sends two pulses per revolution. These pulses
307
 
        // may not be exactly evenly distributed around the rotation, so
308
 
        // we can't recalculate times on every pulse. Instead, we ignore
309
 
        // every other pulse so timings are based on a complete rotation.
310
 
        static bool ignore = true;
311
 
        ignore = !ignore;
312
 
        if( !ignore )
313
 
        {
314
 
                // set a new pulse time
315
 
                new_pulse_at = micros();
316
 
        }
317
 
}
318
 
 
319
 
 
320
 
// main setup
321
 
void setup()
322
 
{
323
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
324
 
        attachInterrupt( 0, fanPulseHandler, RISING );
325
 
        digitalWrite( 2, HIGH );
326
 
  
327
 
        // set up output pins (4 to 13) for the led array
328
 
        for( int a = 4; a < 14; a++ )
329
 
                pinMode( a, OUTPUT );
330
 
 
331
 
        // set up mode-switch button on pin 3
332
 
        pinMode( 3, INPUT );
333
 
        digitalWrite( 3, HIGH );
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 );
344
 
}
345
 
 
346
 
 
347
 
// main loop
348
 
void loop()
349
 
{
350
 
        // if there has been a new pulse, we'll be resetting the display
351
 
        bool reset = new_pulse_at? true : false;
352
 
 
353
 
        // only do this stuff at the start of a display cycle, to ensure
354
 
        // that no state changes mid-display
355
 
        if( reset )
356
 
        {
357
 
                // check buttons
358
 
                checkButtons();
359
 
 
360
 
                // keep track of time
361
 
                trackTime();
362
 
        }
363
 
 
364
 
        // draw this segment
365
 
        drawNextSegment( reset );
366
 
 
367
 
        // do we need to recalculate segment times?
368
 
        if( reset )
369
 
                calculateSegmentTimes();
370
 
 
371
 
        // wait till it's time to draw the next segment
372
 
        waitTillNextSegment( reset );
373
 
}