/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-01-18 23:22:57 UTC
  • Revision ID: edam@waxworlds.org-20120118232257-a3323t3u7nd84zbd
updated led test and added real-time clock to the schematic

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
1
1
/*
2
 
 * propeller-clock.pde
 
2
 * propeller-clock.ino
3
3
 *
4
 
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
5
 *
6
6
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/software/arduino/propeller-clock for more
 
7
 * program"). See http://ed.am/dev/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
 
24
82
//_____________________________________________________________________________
25
83
//                                                                         data
26
84
 
40
98
static unsigned long segment_step_sub_step = 0;
41
99
static unsigned long segment_step_sub = 0;
42
100
 
 
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
 
43
112
// number of segments in a full display (rotation) is 60 (one per
44
113
// second) times the desired number of sub-divisions of a second
45
 
#define NUM_SEGMENTS ( 60 * 5 )
46
 
 
 
114
#define NUM_SECOND_SEGMENTS 5
 
115
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
47
116
 
48
117
//_____________________________________________________________________________
49
118
//                                                                         code
50
119
 
51
120
 
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();
 
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
                }
65
159
        }
66
160
}
67
161
 
68
162
 
69
 
// draw a particular segment
70
 
void drawNextSegment( bool reset )
 
163
// draw a segment for the test display
 
164
void drawNextSegment_test( bool reset )
71
165
{
 
166
        // keep track of segment
72
167
        static unsigned int segment = 0;
73
168
        if( reset ) segment = 0;
74
169
        segment++;
75
170
 
76
 
        for( int a = 0; a < 10; a++ )
77
 
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
171
        // turn on inside and outside LEDs
 
172
        digitalWrite( 4, HIGH );
 
173
        digitalWrite( 13, HIGH );
 
174
 
 
175
        // display segment number in binary across in the inside LEDs,
 
176
        // with the LED on pin 12 showing the least-significant bit
 
177
        for( int a = 0; a < 8; a++ )
 
178
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
179
}
 
180
 
 
181
 
 
182
// draw a segment for the time display
 
183
void drawNextSegment_time( bool reset )
 
184
{
 
185
        static unsigned int second = 0;
 
186
        static unsigned int segment = 0;
 
187
 
 
188
        // handle display reset
 
189
        if( reset ) {
 
190
                second = 0;
 
191
                segment = 0;
 
192
        }
 
193
 
 
194
        // what needs to be drawn?
 
195
        bool draw_tick = !segment && second % 5 == 0;
 
196
        bool draw_second = !segment && second == time_seconds;
 
197
        bool draw_minute = !segment && second == time_minutes;
 
198
        bool draw_hour = !segment && second == time_hours;
 
199
 
 
200
        // set the LEDs
 
201
        digitalWrite( 13, HIGH );
 
202
        digitalWrite( 12, draw_tick || draw_minute );
 
203
        for( int a = 10; a <= 11; a++ )
 
204
                digitalWrite( a, draw_minute || draw_second );
 
205
        for( int a = 4; a <= 9; a++ )
 
206
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
 
207
 
 
208
        // inc position
 
209
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
 
210
                segment = 0;
 
211
                second++;
 
212
        }
 
213
}
 
214
 
 
215
 
 
216
// draw a display segment
 
217
void drawNextSegment( bool reset )
 
218
{
 
219
        static int draw_mode = 0;
 
220
 
 
221
        // handle mode switch requests
 
222
        if( reset && inc_draw_mode ) {
 
223
                inc_draw_mode = false;
 
224
                draw_mode++;
 
225
                if( draw_mode >= 2 )
 
226
                        draw_mode = 0;
 
227
        }
 
228
 
 
229
        // draw the segment
 
230
        switch( draw_mode ) {
 
231
        case 0: drawNextSegment_test( reset ); break;
 
232
        case 1: drawNextSegment_time( reset ); break;
 
233
        }
78
234
}
79
235
 
80
236
 
111
267
 
112
268
        // work out the time that this segment should be displayed until
113
269
        end_time += segment_step;
114
 
        semgment_step_sub += semgment_step_sub_step;
115
 
        if( semgment_step_sub >= NUM_SEGMENTS ) {
116
 
                semgment_step_sub -= NUM_SEGMENTS;
 
270
        segment_step_sub += segment_step_sub_step;
 
271
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
272
                segment_step_sub -= NUM_SEGMENTS;
117
273
                end_time++;
118
274
        }
119
275
 
122
278
}
123
279
 
124
280
 
 
281
// ISR to handle the pulses from the fan's tachiometer
 
282
void fanPulseHandler()
 
283
{
 
284
        // the fan actually sends two pulses per revolution. These pulses
 
285
        // may not be exactly evenly distributed around the rotation, so
 
286
        // we can't recalculate times on every pulse. Instead, we ignore
 
287
        // every other pulse so timings are based on a complete rotation.
 
288
        static bool ignore = true;
 
289
        ignore = !ignore;
 
290
        if( !ignore )
 
291
        {
 
292
                // set a new pulse time
 
293
                new_pulse_at = micros();
 
294
        }
 
295
}
 
296
 
 
297
 
125
298
// main setup
126
299
void setup()
127
300
{
133
306
        for( int a = 4; a < 14; a++ )
134
307
                pinMode( a, OUTPUT );
135
308
 
 
309
        // set up mode-switch button on pin 3
 
310
        pinMode( 3, INPUT );
 
311
 
 
312
        // get the time from the real-time clock
 
313
        int rtc_data[ 7 ];
 
314
        RTC.get( rtc_data, true );
 
315
        time_hours = rtc_data[ DS1307_HR ];
 
316
        time_minutes = rtc_data[ DS1307_MIN ];
 
317
        time_seconds = rtc_data[ DS1307_SEC ];
 
318
 
136
319
        // serial comms
137
320
        Serial.begin( 9600 );
138
321
}
144
327
        // if there has been a new pulse, we'll be resetting the display
145
328
        bool reset = new_pulse_at? true : false;
146
329
 
 
330
        // only do this stuff at the start of a display cycle, to ensure
 
331
        // that no state changes mid-display
 
332
        if( reset )
 
333
        {
 
334
                // check buttons
 
335
                checkButtons();
 
336
 
 
337
                // keep track of time
 
338
                trackTime();
 
339
        }
 
340
 
147
341
        // draw this segment
148
342
        drawNextSegment( reset );
149
343