/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 propeller-clock/propeller-clock.pde

  • Committer: edam
  • Date: 2011-11-17 13:11:02 UTC
  • Revision ID: edam@waxworlds.org-20111117131102-ihs5tz2hynj18h0r
moved schematic and Makefile to propeller-clock dir and updated Makefile for Arduino Pro Mini w/ Atmel 168 board

Show diffs side-by-side

added added

removed removed

Lines of Context:
propeller-clock/propeller-clock.pde
1
1
/*
2
 
 * propeller-clock.ino
 
2
 * propeller-clock.pde
3
3
 *
4
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
4
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
5
5
 *
6
6
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
7
 * program"). See http://ed.am/software/arduino/propeller-clock for more
8
8
 * information.
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
21
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
22
 */
23
23
 
24
 
/******************************************************************************
25
 
 
26
 
Set up:
27
 
 
28
 
 * a PC fan is wired up to a 12V power supply
29
 
 
30
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
31
 
   arduino.
32
 
 
33
 
 * the pins 4 to 13 on the arduino should directly drive an LED (the
34
 
   LED on pin 4 is in the centre of the clock face and the LED on pin
35
 
   13 is at the outside.
36
 
 
37
 
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
38
 
   used to indirectly drive a transistor which in turn drives several
39
 
   LEDs that turn on anf off in unison in the centre of the clock.
40
 
 
41
 
 * a button should be attached to pin 3 that grounds it when pressed.
42
 
 
43
 
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
44
 
 
45
 
Implementation details:
46
 
 
47
 
 * for a schematic, see ../project/propeller-clock.sch.
48
 
 
49
 
 * the timing of the drawing of the clock face is recalculated with
50
 
   every rotation of the propeller.
51
 
    
52
 
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
53
 
   software skips every other one. This means that the clock may
54
 
   appear upside-down if started with the propeller in the wrong
55
 
   position. You will need to experiment to dicsover the position that
56
 
   the propeller must be in when starting the clock.
57
 
    
58
 
Usage instructions:
59
 
 
60
 
 * pressing the button cycles between variations of the current
61
 
   display mode.
62
 
  
63
 
 * pressing and holding the button for a second cycles between display
64
 
   modes (e.g., analogue and digital).
65
 
 
66
 
 * pressing and holding the button for 5 seconds enters "time set"
67
 
   mode. In this mode, the following applies:
68
 
    - the field that is being set flashes
69
 
    - pressing the button increments the field currently being set
70
 
    - pressing and holding the button for a second cycles through the
71
 
      fields that can be set
72
 
    - pressing and holding the button for 5 seconds sets the time and
73
 
      exits "time set" mode
74
 
 
75
 
******************************************************************************/
76
 
 
77
 
 
78
 
#include <Bounce.h>
79
 
#include <DS1307.h>
80
 
#include <Wire.h>
81
 
 
82
24
//_____________________________________________________________________________
83
25
//                                                                         data
84
26
 
98
40
static unsigned long segment_step_sub_step = 0;
99
41
static unsigned long segment_step_sub = 0;
100
42
 
101
 
// flag to indicate that the drawing mode should be cycled to the next one
102
 
static bool inc_draw_mode = false;
103
 
 
104
 
// a bounce-managed button
105
 
static Bounce button( 3, 5 );
106
 
 
107
 
// the time
108
 
static int time_hours = 0;
109
 
static int time_minutes = 0;
110
 
static int time_seconds = 0;
111
 
 
112
43
// number of segments in a full display (rotation) is 60 (one per
113
44
// second) times the desired number of sub-divisions of a second
114
 
#define NUM_SECOND_SEGMENTS 5
115
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
45
#define NUM_SEGMENTS ( 60 * 5 )
 
46
 
116
47
 
117
48
//_____________________________________________________________________________
118
49
//                                                                         code
119
50
 
120
51
 
121
 
// check for button presses
122
 
void checkButtons()
123
 
{
124
 
        // update buttons
125
 
        button.update();
126
 
 
127
 
        // notice button presses
128
 
        if( button.risingEdge() )
129
 
                inc_draw_mode = true;
130
 
}
131
 
 
132
 
 
133
 
// keep track of time
134
 
void trackTime()
135
 
{
136
 
        // previous time and any carried-over milliseconds
137
 
        static unsigned long last_time = millis();
138
 
        static unsigned long carry = 0;
139
 
 
140
 
        // how many milliseonds have elapsed since we last checked?
141
 
        unsigned long next_time = millis();
142
 
        unsigned long delta = next_time - last_time + carry;
143
 
 
144
 
        // update the previous time and carried-over milliseconds
145
 
        last_time = next_time;
146
 
        carry = delta % 1000;
147
 
 
148
 
        // add the seconds that have passed to the time
149
 
        time_seconds += delta / 1000;
150
 
        while( time_seconds >= 60 ) {
151
 
                time_seconds -= 60;
152
 
                time_minutes++;
153
 
                if( time_minutes >= 60 ) {
154
 
                        time_minutes -= 60;
155
 
                        time_hours++;
156
 
                        if( time_hours >= 24 )
157
 
                                time_hours -= 24;
158
 
                }
 
52
// ISR to handle the pulses from the fan's tachiometer
 
53
void fanPulseHandler()
 
54
{
 
55
        // the fan actually sends two pulses per revolution. These pulses
 
56
        // may not be exactly evenly distributed around the rotation, so
 
57
        // we can't recalculate times on every pulse. Instead, we ignore
 
58
        // every other pulse so timings are based on a complete rotation.
 
59
        static bool ignore = true;
 
60
        ignore = !ignore;
 
61
        if( !ignore )
 
62
        {
 
63
                // set a new pulse time
 
64
                new_pulse_at = micros();
159
65
        }
160
66
}
161
67
 
162
68
 
163
 
// turn an led on/off
164
 
void ledOn( int num, bool on )
165
 
{
166
 
        if( num < 0 || num > 9 ) return;
167
 
 
168
 
        // convert to pin no.
169
 
        num += 4;
170
 
 
171
 
        // pin 4 needs to be inverted (it's driving a PNP)
172
 
        if( num == 4 ) on = !on;
173
 
 
174
 
        digitalWrite( num, on? HIGH : LOW );
175
 
}
176
 
 
177
 
 
178
 
// draw a segment for the test display
179
 
void drawNextSegment_test( bool reset )
180
 
{
181
 
        // keep track of segment
 
69
// draw a particular segment
 
70
void drawNextSegment( bool reset )
 
71
{
182
72
        static unsigned int segment = 0;
183
73
        if( reset ) segment = 0;
184
74
        segment++;
185
75
 
186
 
        // turn on inside and outside LEDs
187
 
        ledOn( 0, true );
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 < 8; a++ )
193
 
                ledOn( 8 - a, ( segment >> a ) & 1 );
194
 
}
195
 
 
196
 
 
197
 
// draw a segment for the time display
198
 
void drawNextSegment_time( bool reset )
199
 
{
200
 
        static int second = 0;
201
 
        static int segment = 0;
202
 
 
203
 
        // handle display reset
204
 
        if( reset ) {
205
 
                second = 0;
206
 
                segment = 0;
207
 
        }
208
 
 
209
 
        // what needs to be drawn?
210
 
        bool draw_tick = !segment && second % 5 == 0;
211
 
        bool draw_second = !segment && second == time_seconds;
212
 
        bool draw_minute = !segment && second == time_minutes;
213
 
        bool draw_hour = !segment && second == time_hours;
214
 
 
215
 
        // set the LEDs
216
 
        ledOn( 9, true );
217
 
        ledOn( 8, draw_tick || draw_minute );
218
 
        for( int a = 6; a <= 7; a++ )
219
 
                ledOn( a, draw_minute || draw_second );
220
 
        for( int a = 0; a <= 5; a++ )
221
 
                ledOn( a, draw_minute || draw_second || draw_hour );
222
 
 
223
 
        // inc position
224
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
225
 
                segment = 0;
226
 
                second++;
227
 
        }
228
 
}
229
 
 
230
 
 
231
 
// draw a display segment
232
 
void drawNextSegment( bool reset )
233
 
{
234
 
        static int draw_mode = 0;
235
 
 
236
 
        // handle mode switch requests
237
 
        if( reset && inc_draw_mode ) {
238
 
                inc_draw_mode = false;
239
 
                draw_mode++;
240
 
                if( draw_mode >= 2 )
241
 
                        draw_mode = 0;
242
 
        }
243
 
 
244
 
        // draw the segment
245
 
        switch( draw_mode ) {
246
 
        case 0: drawNextSegment_test( reset ); break;
247
 
        case 1: drawNextSegment_time( reset ); break;
248
 
        }
 
76
        for( int a = 0; a < 10; a++ )
 
77
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
249
78
}
250
79
 
251
80
 
282
111
 
283
112
        // work out the time that this segment should be displayed until
284
113
        end_time += segment_step;
285
 
        segment_step_sub += segment_step_sub_step;
286
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
287
 
                segment_step_sub -= NUM_SEGMENTS;
 
114
        semgment_step_sub += semgment_step_sub_step;
 
115
        if( semgment_step_sub >= NUM_SEGMENTS ) {
 
116
                semgment_step_sub -= NUM_SEGMENTS;
288
117
                end_time++;
289
118
        }
290
119
 
293
122
}
294
123
 
295
124
 
296
 
// ISR to handle the pulses from the fan's tachiometer
297
 
void fanPulseHandler()
298
 
{
299
 
        // the fan actually sends two pulses per revolution. These pulses
300
 
        // may not be exactly evenly distributed around the rotation, so
301
 
        // we can't recalculate times on every pulse. Instead, we ignore
302
 
        // every other pulse so timings are based on a complete rotation.
303
 
        static bool ignore = true;
304
 
        ignore = !ignore;
305
 
        if( !ignore )
306
 
        {
307
 
                // set a new pulse time
308
 
                new_pulse_at = micros();
309
 
        }
310
 
}
311
 
 
312
 
 
313
125
// main setup
314
126
void setup()
315
127
{
321
133
        for( int a = 4; a < 14; a++ )
322
134
                pinMode( a, OUTPUT );
323
135
 
324
 
        // set up mode-switch button on pin 3
325
 
        pinMode( 3, INPUT );
326
 
 
327
 
        // get the time from the real-time clock
328
 
        int rtc_data[ 7 ];
329
 
        RTC.get( rtc_data, true );
330
 
        time_hours = rtc_data[ DS1307_HR ];
331
 
        time_minutes = rtc_data[ DS1307_MIN ];
332
 
        time_seconds = rtc_data[ DS1307_SEC ];
333
 
 
334
136
        // serial comms
335
137
        Serial.begin( 9600 );
336
138
}
342
144
        // if there has been a new pulse, we'll be resetting the display
343
145
        bool reset = new_pulse_at? true : false;
344
146
 
345
 
        // only do this stuff at the start of a display cycle, to ensure
346
 
        // that no state changes mid-display
347
 
        if( reset )
348
 
        {
349
 
                // check buttons
350
 
                checkButtons();
351
 
 
352
 
                // keep track of time
353
 
                trackTime();
354
 
        }
355
 
 
356
147
        // draw this segment
357
148
        drawNextSegment( reset );
358
149