/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 13:04:29 UTC
  • Revision ID: tim@ed.am-20120310130429-310w5ejo968mc6mo
cleaned-up notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.cc
28
28
 
29
29
 * a PC fan is wired up to a 12V power supply
30
30
 
31
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
32
 
   arduino.
 
31
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
 
32
   Arduino.
33
33
 
34
 
 * the pins 4 to 13 on the arduino should directly drive an LED (the
 
34
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
35
35
   LED on pin 4 is in the centre of the clock face and the LED on pin
36
36
   13 is at the outside.
37
37
 
38
38
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
39
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.
 
40
   LEDs that turn on and off in unison in the centre of the clock.
41
41
 
42
42
 * a button should be attached to pin 3 that grounds it when pressed.
43
43
 
44
 
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
 
44
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
45
45
 
46
46
Implementation details:
47
47
 
50
50
 * the timing of the drawing of the clock face is recalculated with
51
51
   every rotation of the propeller.
52
52
    
53
 
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
 
53
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
54
54
   software skips every other one. This means that the clock may
55
55
   appear upside-down if started with the propeller in the wrong
56
 
   position. You will need to experiment to dicsover the position that
 
56
   position. You will need to experiment to discover the position that
57
57
   the propeller must be in when starting the clock.
58
58
    
59
59
Usage instructions:
76
76
******************************************************************************/
77
77
 
78
78
#include "config.h"
79
 
#include "display.h"
80
79
#include "button.h"
81
80
#include "time.h"
82
 
#include "switcher_major_mode.h"
83
 
#include "drawer.h"
 
81
#include "Arduino.h"
 
82
#include "analogue_clock.h"
 
83
#include "digital_clock.h"
 
84
#include "test_pattern.h"
84
85
 
85
86
//_____________________________________________________________________________
86
87
//                                                                         data
87
88
 
88
 
 
89
89
// when non-zero, the time (in microseconds) of a new fan pulse that
90
90
// has just occurred, which means that segment drawing needs to be
91
91
// restarted
92
 
static unsigned long new_pulse_at = 0;
 
92
static unsigned long _new_pulse_at = 0;
93
93
 
94
94
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long last_pulse_at = 0;
 
95
static unsigned long _last_pulse_at = 0;
96
96
 
97
97
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long segment_step = 0;
 
98
static unsigned long _segment_step = 0;
99
99
 
100
100
// remainder after divisor and a tally of the remainders for each segment
101
 
static unsigned long segment_step_sub_step = 0;
102
 
static unsigned long segment_step_sub = 0;
 
101
static unsigned long _segment_step_sub_step = 0;
 
102
static unsigned long _segment_step_sub = 0;
103
103
 
104
104
// the button
105
 
static Button button( 3 );
106
 
 
107
 
// major mode
108
 
static int major_mode = 0;
109
 
 
110
 
#define MAX_MAJOR_MODES 5
111
 
 
112
 
// major modes
113
 
static MajorMode *major_modes[ MAX_MAJOR_MODES ] = { 0 };
 
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
114
116
 
115
117
//_____________________________________________________________________________
116
118
//                                                                         code
117
119
 
118
120
 
 
121
// activate the current minor mode
 
122
void activate_minor_mode()
 
123
{
 
124
        switch( _minor_mode ) {
 
125
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
 
126
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
127
        }
 
128
}
 
129
 
119
130
// perform button events
120
 
void doButtonEvents()
 
131
void do_button_events()
121
132
{
122
133
        // loop through pending events
123
 
        while( int event = button.get_event() )
 
134
        while( int event = _button.get_event() )
124
135
        {
125
136
                switch( event )
126
137
                {
127
138
                case 1:
128
139
                        // short press
129
 
                        major_modes[ major_mode ]->press();
 
140
                        switch( _major_mode ) {
 
141
                        case MAIN_MODE_IDX:
 
142
                                switch( _minor_mode ) {
 
143
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
144
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
145
                                }
 
146
                                break;
 
147
                        }
130
148
                        break;
131
149
 
132
150
                case 2:
133
151
                        // long press
134
 
                        major_modes[ major_mode ]->long_press();
 
152
                        switch( _major_mode ) {
 
153
                        case MAIN_MODE_IDX:
 
154
                                if( ++_minor_mode >= 3 )
 
155
                                        _minor_mode = 0;
 
156
                                switch( _minor_mode ) {
 
157
                                case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
158
                                }
 
159
                                break;
 
160
                        }
135
161
                        break;
136
162
 
137
163
                case 3:
138
164
                        // looooong press (change major mode)
139
 
                        do {
140
 
                                if( ++major_mode >= MAX_MAJOR_MODES )
141
 
                                        major_mode = 0;
142
 
                        } while( major_modes[ major_mode ] == NULL );
143
 
                        major_modes[ major_mode ]->activate();
 
165
                        if( ++_major_mode > 0 )
 
166
                                _major_mode = 0;
 
167
                        switch( _major_mode ) {
 
168
                        case MAIN_MODE_IDX: _minor_mode = 0; break;
 
169
                        }
 
170
                        activate_minor_mode();
144
171
                        break;
145
 
 
146
172
                }
147
173
        }
148
174
}
149
175
 
150
176
 
151
177
// draw a display segment
152
 
void drawNextSegment( bool reset )
 
178
void draw_next_segment( bool reset )
153
179
{
154
180
        // keep track of segment
155
181
#if CLOCK_FORWARD
160
186
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
161
187
#endif
162
188
 
 
189
        // frame reset
 
190
        if( reset ) {
 
191
                switch( _major_mode ) {
 
192
                case MAIN_MODE_IDX:
 
193
                        switch( _minor_mode ) {
 
194
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
195
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
196
                        }
 
197
                        break;
 
198
                }
 
199
        }
 
200
 
163
201
        // draw
164
 
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
165
 
        if( reset ) drawer.draw_reset();
166
 
        drawer.draw( segment );
 
202
        switch( _major_mode ) {
 
203
        case MAIN_MODE_IDX:
 
204
                switch( _minor_mode ) {
 
205
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
206
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
207
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
208
                }
 
209
                break;
 
210
        }
167
211
 
168
212
#if CLOCK_FORWARD
169
213
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
174
218
 
175
219
 
176
220
// calculate time constants when a new pulse has occurred
177
 
void calculateSegmentTimes()
 
221
void calculate_segment_times()
178
222
{
179
223
        // check for overflows, and only recalculate times if there isn't
180
224
        // one (if there is, we'll just go with the last pulse's times)
181
 
        if( new_pulse_at > last_pulse_at )
 
225
        if( _new_pulse_at > _last_pulse_at )
182
226
        {
183
227
                // new segment stepping times
184
 
                unsigned long delta = new_pulse_at - last_pulse_at;
185
 
                segment_step = delta / NUM_SEGMENTS;
186
 
                segment_step_sub = 0;
187
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
228
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
229
                _segment_step = delta / NUM_SEGMENTS;
 
230
                _segment_step_sub = 0;
 
231
                _segment_step_sub_step = delta % NUM_SEGMENTS;
188
232
        }
189
233
 
190
234
        // now we have dealt with this pulse, save the pulse time and
191
235
        // clear new_pulse_at, ready for the next pulse
192
 
        last_pulse_at = new_pulse_at;
193
 
        new_pulse_at = 0;
 
236
        _last_pulse_at = _new_pulse_at;
 
237
        _new_pulse_at = 0;
194
238
}
195
239
 
196
240
 
197
241
// wait until it is time to draw the next segment or a new pulse has
198
242
// occurred
199
 
void waitTillEndOfSegment( bool reset )
 
243
void wait_till_end_of_segment( bool reset )
200
244
{
201
245
        static unsigned long end_time = 0;
202
246
 
203
247
        // handle reset
204
248
        if( reset )
205
 
                end_time = last_pulse_at;
 
249
                end_time = _last_pulse_at;
206
250
 
207
251
        // work out the time that this segment should be displayed until
208
 
        end_time += segment_step;
209
 
        segment_step_sub += segment_step_sub_step;
210
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
211
 
                segment_step_sub -= NUM_SEGMENTS;
 
252
        end_time += _segment_step;
 
253
        _segment_step_sub += _segment_step_sub_step;
 
254
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
255
                _segment_step_sub -= NUM_SEGMENTS;
212
256
                end_time++;
213
257
        }
214
258
 
215
259
        // wait
216
 
        while( micros() < end_time && !new_pulse_at );
 
260
        while( micros() < end_time && !_new_pulse_at );
217
261
}
218
262
 
219
263
 
220
264
// ISR to handle the pulses from the fan's tachiometer
221
 
void fanPulseHandler()
 
265
void fan_pulse_handler()
222
266
{
223
267
        // the fan actually sends two pulses per revolution. These pulses
224
268
        // may not be exactly evenly distributed around the rotation, so
229
273
        if( !ignore )
230
274
        {
231
275
                // set a new pulse time
232
 
                new_pulse_at = micros();
 
276
                _new_pulse_at = micros();
233
277
        }
234
278
}
235
279
 
238
282
void setup()
239
283
{
240
284
        // set up an interrupt handler on pin 2 to nitice fan pulses
241
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
285
        attachInterrupt( 0, fan_pulse_handler, RISING );
242
286
        digitalWrite( 2, HIGH );
243
287
  
244
288
        // set up output pins (4 to 13) for the led array
249
293
        pinMode( 3, INPUT );
250
294
        digitalWrite( 3, HIGH );
251
295
        static int event_times[] = { 5, 500, 4000, 0 };
252
 
        button.set_event_times( event_times );
253
 
 
254
 
        // set up major modes
255
 
        static SwitcherMajorMode switcher_major_mode;
256
 
        int mode = 0;
257
 
        major_modes[ mode++ ] = &switcher_major_mode;
258
 
        major_modes[ 0 ]->activate();
 
296
        _button.set_event_times( event_times );
 
297
 
 
298
        // initialise RTC
 
299
        Time::init();
 
300
 
 
301
        // activate the minor mode
 
302
        switch( _major_mode ) {
 
303
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
304
        }
259
305
}
260
306
 
261
307
 
263
309
void loop()
264
310
{
265
311
        // if there has been a new pulse, we'll be resetting the display
266
 
        bool reset = new_pulse_at? true : false;
 
312
        bool reset = _new_pulse_at? true : false;
267
313
 
268
314
        // update button
269
 
        button.update();
 
315
        _button.update();
270
316
 
271
317
        // only do this stuff at the start of a display cycle, to ensure
272
318
        // that no state changes mid-display
273
319
        if( reset )
274
320
        {
275
321
                // calculate segment times
276
 
                calculateSegmentTimes();
 
322
                calculate_segment_times();
277
323
 
278
324
                // keep track of time
279
 
                Time &time = Time::get_instance();
280
 
                time.update();
 
325
                Time::update();
281
326
 
282
327
                // perform button events
283
 
                doButtonEvents();
 
328
                do_button_events();
284
329
        }
285
330
 
286
331
        // draw this segment
287
 
        drawNextSegment( reset );
 
332
        draw_next_segment( reset );
288
333
 
289
334
        // wait till it's time to draw the next segment
290
 
        waitTillEndOfSegment( reset );
 
335
        wait_till_end_of_segment( reset );
291
336
}