/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.cc

  • Committer: Tim Marston
  • Date: 2012-03-10 12:31:16 UTC
  • Revision ID: tim@ed.am-20120310123116-l348p5btgecmdj1q
added realtime clock test

Show diffs side-by-side

added added

removed removed

src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
1
2
/*
2
 
 * propeller-clock.pde
 
3
 * propeller-clock.ino
3
4
 *
4
 
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
 
5
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
6
 *
6
7
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/software/arduino/propeller-clock for more
 
8
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
8
9
 * information.
9
10
 *
10
11
 * This program is free software: you can redistribute it and/or modify
21
22
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23
 */
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
#include "config.h"
 
79
#include "button.h"
 
80
#include "time.h"
 
81
#include "Arduino.h"
 
82
#include "analogue_clock.h"
 
83
#include "digital_clock.h"
 
84
#include "test_pattern.h"
 
85
 
24
86
//_____________________________________________________________________________
25
87
//                                                                         data
26
88
 
27
 
 
28
89
// when non-zero, the time (in microseconds) of a new fan pulse that
29
90
// has just occurred, which means that segment drawing needs to be
30
91
// restarted
31
 
static unsigned long new_pulse_at = 0;
 
92
static unsigned long _new_pulse_at = 0;
32
93
 
33
94
// the time (in microseconds) when the last fan pulse occurred
34
 
static unsigned long last_pulse_at = 0;
 
95
static unsigned long _last_pulse_at = 0;
35
96
 
36
97
// duration (in microseconds) that a segment should be displayed
37
 
static unsigned long segment_step = 0;
 
98
static unsigned long _segment_step = 0;
38
99
 
39
100
// remainder after divisor and a tally of the remainders for each segment
40
 
static unsigned long segment_step_sub_step = 0;
41
 
static unsigned long segment_step_sub = 0;
42
 
 
43
 
// display mode
44
 
static
45
 
 
 
101
static unsigned long _segment_step_sub_step = 0;
 
102
static unsigned long _segment_step_sub = 0;
 
103
 
 
104
// the button
 
105
static Button _button( 3 );
 
106
 
 
107
// modes
 
108
static int _major_mode = 0;
 
109
static int _minor_mode = 0;
 
110
 
 
111
#define MAIN_MODE_IDX 0
 
112
 
 
113
#define ANALOGUE_CLOCK_IDX 0
 
114
#define DIGITAL_CLOCK_IDX 1
 
115
#define TEST_PATTERN_IDX 2
46
116
 
47
117
//_____________________________________________________________________________
48
118
//                                                                         code
49
119
 
50
120
 
51
 
// ISR to handle the pulses from the fan's tachiometer
52
 
void fanPulseHandler()
53
 
{
54
 
        // the fan actually sends two pulses per revolution. These pulses
55
 
        // may not be exactly evenly distributed around the rotation, so
56
 
        // we can't recalculate times on every pulse. Instead, we ignore
57
 
        // every other pulse so timings are based on a complete rotation.
58
 
        static bool ignore = true;
59
 
        ignore = !ignore;
60
 
        if( !ignore )
 
121
// activate the current minor mode
 
122
void activate_minor_mode()
 
123
{
 
124
        switch( _minor_mode ) {
 
125
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
126
        }
 
127
}
 
128
 
 
129
// perform button events
 
130
void do_button_events()
 
131
{
 
132
        // loop through pending events
 
133
        while( int event = _button.get_event() )
61
134
        {
62
 
                // set a new pulse time
63
 
                new_pulse_at = micros();
 
135
                switch( event )
 
136
                {
 
137
                case 1:
 
138
                        // short press
 
139
                        switch( _major_mode ) {
 
140
                        case MAIN_MODE_IDX:
 
141
                                switch( _minor_mode ) {
 
142
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
143
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
144
                                }
 
145
                                break;
 
146
                        }
 
147
                        break;
 
148
 
 
149
                case 2:
 
150
                        // long press
 
151
                        switch( _major_mode ) {
 
152
                        case MAIN_MODE_IDX:
 
153
                                if( ++_minor_mode >= 3 )
 
154
                                        _minor_mode = 0;
 
155
                                switch( _minor_mode ) {
 
156
                                case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
157
                                }
 
158
                                break;
 
159
                        }
 
160
                        break;
 
161
 
 
162
                case 3:
 
163
                        // looooong press (change major mode)
 
164
                        if( ++_major_mode > 0 )
 
165
                                _major_mode = 0;
 
166
                        switch( _major_mode ) {
 
167
                        case MAIN_MODE_IDX: _minor_mode = 0; break;
 
168
                        }
 
169
                        activate_minor_mode();
 
170
                        break;
 
171
                }
64
172
        }
65
173
}
66
174
 
67
175
 
68
 
// draw a particular segment
69
 
void drawNextSegment( bool reset )
 
176
// draw a display segment
 
177
void draw_next_segment( bool reset )
70
178
{
71
 
        static unsigned int segment = 0;
72
 
        if( reset ) segment = 0;
73
 
        segment++;
74
 
 
75
 
        for( int a = 0; a < 10; a++ )
76
 
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
179
        // keep track of segment
 
180
#if CLOCK_FORWARD
 
181
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
182
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
183
#else
 
184
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
185
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
186
#endif
 
187
 
 
188
        // draw
 
189
        switch( _major_mode ) {
 
190
        case MAIN_MODE_IDX:
 
191
                switch( _minor_mode ) {
 
192
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
193
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
194
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
195
                }
 
196
                break;
 
197
        }
 
198
 
 
199
#if CLOCK_FORWARD
 
200
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
201
#else
 
202
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
203
#endif
77
204
}
78
205
 
79
206
 
80
207
// calculate time constants when a new pulse has occurred
81
 
void calculateSegmentTimes()
 
208
void calculate_segment_times()
82
209
{
83
210
        // check for overflows, and only recalculate times if there isn't
84
211
        // one (if there is, we'll just go with the last pulse's times)
85
 
        if( new_pulse_at > last_pulse_at )
 
212
        if( _new_pulse_at > _last_pulse_at )
86
213
        {
87
214
                // new segment stepping times
88
 
                unsigned long delta = new_pulse_at - last_pulse_at;
89
 
                segment_step = delta / NUM_SEGMENTS;
90
 
                segment_step_sub = 0;
91
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
215
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
216
                _segment_step = delta / NUM_SEGMENTS;
 
217
                _segment_step_sub = 0;
 
218
                _segment_step_sub_step = delta % NUM_SEGMENTS;
92
219
        }
93
220
 
94
221
        // now we have dealt with this pulse, save the pulse time and
95
222
        // clear new_pulse_at, ready for the next pulse
96
 
        last_pulse_at = new_pulse_at;
97
 
        new_pulse_at = 0;
 
223
        _last_pulse_at = _new_pulse_at;
 
224
        _new_pulse_at = 0;
98
225
}
99
226
 
100
227
 
101
228
// wait until it is time to draw the next segment or a new pulse has
102
229
// occurred
103
 
void waitTillNextSegment( bool reset )
 
230
void wait_till_end_of_segment( bool reset )
104
231
{
105
232
        static unsigned long end_time = 0;
106
233
 
107
234
        // handle reset
108
235
        if( reset )
109
 
                end_time = last_pulse_at;
 
236
                end_time = _last_pulse_at;
110
237
 
111
238
        // work out the time that this segment should be displayed until
112
 
        end_time += segment_step;
113
 
        semgment_step_sub += semgment_step_sub_step;
114
 
        if( semgment_step_sub >= NUM_SEGMENTS ) {
115
 
                semgment_step_sub -= NUM_SEGMENTS;
 
239
        end_time += _segment_step;
 
240
        _segment_step_sub += _segment_step_sub_step;
 
241
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
242
                _segment_step_sub -= NUM_SEGMENTS;
116
243
                end_time++;
117
244
        }
118
245
 
119
246
        // wait
120
 
        while( micros() < end_time && !new_pulse_at );
 
247
        while( micros() < end_time && !_new_pulse_at );
 
248
}
 
249
 
 
250
 
 
251
// ISR to handle the pulses from the fan's tachiometer
 
252
void fan_pulse_handler()
 
253
{
 
254
        // the fan actually sends two pulses per revolution. These pulses
 
255
        // may not be exactly evenly distributed around the rotation, so
 
256
        // we can't recalculate times on every pulse. Instead, we ignore
 
257
        // every other pulse so timings are based on a complete rotation.
 
258
        static bool ignore = true;
 
259
        ignore = !ignore;
 
260
        if( !ignore )
 
261
        {
 
262
                // set a new pulse time
 
263
                _new_pulse_at = micros();
 
264
        }
121
265
}
122
266
 
123
267
 
125
269
void setup()
126
270
{
127
271
        // set up an interrupt handler on pin 2 to nitice fan pulses
128
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
272
        attachInterrupt( 0, fan_pulse_handler, RISING );
129
273
        digitalWrite( 2, HIGH );
130
274
  
131
275
        // set up output pins (4 to 13) for the led array
132
276
        for( int a = 4; a < 14; a++ )
133
277
                pinMode( a, OUTPUT );
134
278
 
135
 
        // serial comms
136
 
        Serial.begin( 9600 );
 
279
        // set up mode-switch button on pin 3
 
280
        pinMode( 3, INPUT );
 
281
        digitalWrite( 3, HIGH );
 
282
        static int event_times[] = { 5, 500, 4000, 0 };
 
283
        _button.set_event_times( event_times );
 
284
 
 
285
        // get time from RTC
 
286
        Time::init();
 
287
 
 
288
        // activate the minor mode
 
289
        switch( _major_mode ) {
 
290
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
291
        }
137
292
}
138
293
 
139
294
 
141
296
void loop()
142
297
{
143
298
        // if there has been a new pulse, we'll be resetting the display
144
 
        bool reset = new_pulse_at? true : false;
 
299
        bool reset = _new_pulse_at? true : false;
 
300
 
 
301
        // update button
 
302
        _button.update();
 
303
 
 
304
        // only do this stuff at the start of a display cycle, to ensure
 
305
        // that no state changes mid-display
 
306
        if( reset )
 
307
        {
 
308
                // calculate segment times
 
309
                calculate_segment_times();
 
310
 
 
311
                // keep track of time
 
312
                Time::update();
 
313
 
 
314
                // perform button events
 
315
                do_button_events();
 
316
        }
145
317
 
146
318
        // draw this segment
147
 
        drawNextSegment( reset );
148
 
 
149
 
        // do we need to recalculate segment times?
150
 
        if( reset )
151
 
                calculateSegmentTimes();
 
319
        draw_next_segment( reset );
152
320
 
153
321
        // wait till it's time to draw the next segment
154
 
        waitTillNextSegment( reset );
 
322
        wait_till_end_of_segment( reset );
155
323
}