/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

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"
84
81
#include "Arduino.h"
 
82
#include "analogue_clock.h"
 
83
#include "digital_clock.h"
 
84
#include "test_pattern.h"
85
85
 
86
86
//_____________________________________________________________________________
87
87
//                                                                         data
88
88
 
89
 
 
90
89
// when non-zero, the time (in microseconds) of a new fan pulse that
91
90
// has just occurred, which means that segment drawing needs to be
92
91
// restarted
93
 
static unsigned long new_pulse_at = 0;
 
92
static unsigned long _new_pulse_at = 0;
94
93
 
95
94
// the time (in microseconds) when the last fan pulse occurred
96
 
static unsigned long last_pulse_at = 0;
 
95
static unsigned long _last_pulse_at = 0;
97
96
 
98
97
// duration (in microseconds) that a segment should be displayed
99
 
static unsigned long segment_step = 0;
 
98
static unsigned long _segment_step = 0;
100
99
 
101
100
// remainder after divisor and a tally of the remainders for each segment
102
 
static unsigned long segment_step_sub_step = 0;
103
 
static unsigned long segment_step_sub = 0;
 
101
static unsigned long _segment_step_sub_step = 0;
 
102
static unsigned long _segment_step_sub = 0;
104
103
 
105
104
// the button
106
 
static Button button( 3 );
107
 
 
108
 
// major mode
109
 
static int major_mode = 0;
110
 
 
111
 
#define MAX_MAJOR_MODES 5
112
 
 
113
 
// major modes
114
 
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
115
116
 
116
117
//_____________________________________________________________________________
117
118
//                                                                         code
118
119
 
119
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
 
120
130
// perform button events
121
 
void doButtonEvents()
 
131
void do_button_events()
122
132
{
123
133
        // loop through pending events
124
 
        while( int event = button.get_event() )
 
134
        while( int event = _button.get_event() )
125
135
        {
126
136
                switch( event )
127
137
                {
128
138
                case 1:
129
139
                        // short press
130
 
                        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
                        }
131
148
                        break;
132
149
 
133
150
                case 2:
134
151
                        // long press
135
 
                        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
                        }
136
161
                        break;
137
162
 
138
163
                case 3:
139
164
                        // looooong press (change major mode)
140
 
                        do {
141
 
                                if( ++major_mode >= MAX_MAJOR_MODES )
142
 
                                        major_mode = 0;
143
 
                        } while( major_modes[ major_mode ] == NULL );
144
 
                        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();
145
171
                        break;
146
 
 
147
172
                }
148
173
        }
149
174
}
150
175
 
151
176
 
152
177
// draw a display segment
153
 
void drawNextSegment( bool reset )
 
178
void draw_next_segment( bool reset )
154
179
{
155
180
        // keep track of segment
156
181
#if CLOCK_FORWARD
161
186
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
162
187
#endif
163
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
 
164
201
        // draw
165
 
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
166
 
        if( reset ) drawer.draw_reset();
167
 
        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
        }
168
211
 
169
212
#if CLOCK_FORWARD
170
213
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
175
218
 
176
219
 
177
220
// calculate time constants when a new pulse has occurred
178
 
void calculateSegmentTimes()
 
221
void calculate_segment_times()
179
222
{
180
223
        // check for overflows, and only recalculate times if there isn't
181
224
        // one (if there is, we'll just go with the last pulse's times)
182
 
        if( new_pulse_at > last_pulse_at )
 
225
        if( _new_pulse_at > _last_pulse_at )
183
226
        {
184
227
                // new segment stepping times
185
 
                unsigned long delta = new_pulse_at - last_pulse_at;
186
 
                segment_step = delta / NUM_SEGMENTS;
187
 
                segment_step_sub = 0;
188
 
                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;
189
232
        }
190
233
 
191
234
        // now we have dealt with this pulse, save the pulse time and
192
235
        // clear new_pulse_at, ready for the next pulse
193
 
        last_pulse_at = new_pulse_at;
194
 
        new_pulse_at = 0;
 
236
        _last_pulse_at = _new_pulse_at;
 
237
        _new_pulse_at = 0;
195
238
}
196
239
 
197
240
 
198
241
// wait until it is time to draw the next segment or a new pulse has
199
242
// occurred
200
 
void waitTillEndOfSegment( bool reset )
 
243
void wait_till_end_of_segment( bool reset )
201
244
{
202
245
        static unsigned long end_time = 0;
203
246
 
204
247
        // handle reset
205
248
        if( reset )
206
 
                end_time = last_pulse_at;
 
249
                end_time = _last_pulse_at;
207
250
 
208
251
        // work out the time that this segment should be displayed until
209
 
        end_time += segment_step;
210
 
        segment_step_sub += segment_step_sub_step;
211
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
212
 
                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;
213
256
                end_time++;
214
257
        }
215
258
 
216
259
        // wait
217
 
        while( micros() < end_time && !new_pulse_at );
 
260
        while( micros() < end_time && !_new_pulse_at );
218
261
}
219
262
 
220
263
 
221
264
// ISR to handle the pulses from the fan's tachiometer
222
 
void fanPulseHandler()
 
265
void fan_pulse_handler()
223
266
{
224
267
        // the fan actually sends two pulses per revolution. These pulses
225
268
        // may not be exactly evenly distributed around the rotation, so
230
273
        if( !ignore )
231
274
        {
232
275
                // set a new pulse time
233
 
                new_pulse_at = micros();
 
276
                _new_pulse_at = micros();
234
277
        }
235
278
}
236
279
 
239
282
void setup()
240
283
{
241
284
        // set up an interrupt handler on pin 2 to nitice fan pulses
242
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
285
        attachInterrupt( 0, fan_pulse_handler, RISING );
243
286
        digitalWrite( 2, HIGH );
244
287
  
245
288
        // set up output pins (4 to 13) for the led array
250
293
        pinMode( 3, INPUT );
251
294
        digitalWrite( 3, HIGH );
252
295
        static int event_times[] = { 5, 500, 4000, 0 };
253
 
        button.set_event_times( event_times );
254
 
 
255
 
        // set up major modes
256
 
        static SwitcherMajorMode switcher_major_mode;
257
 
        int mode = 0;
258
 
        major_modes[ mode++ ] = &switcher_major_mode;
259
 
        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
        }
260
305
}
261
306
 
262
307
 
264
309
void loop()
265
310
{
266
311
        // if there has been a new pulse, we'll be resetting the display
267
 
        bool reset = new_pulse_at? true : false;
 
312
        bool reset = _new_pulse_at? true : false;
268
313
 
269
314
        // update button
270
 
        button.update();
 
315
        _button.update();
271
316
 
272
317
        // only do this stuff at the start of a display cycle, to ensure
273
318
        // that no state changes mid-display
274
319
        if( reset )
275
320
        {
276
321
                // calculate segment times
277
 
                calculateSegmentTimes();
 
322
                calculate_segment_times();
278
323
 
279
324
                // keep track of time
280
 
                Time &time = Time::get_instance();
281
 
                time.update();
 
325
                Time::update();
282
326
 
283
327
                // perform button events
284
 
                doButtonEvents();
 
328
                do_button_events();
285
329
        }
286
330
 
287
331
        // draw this segment
288
 
        drawNextSegment( reset );
 
332
        draw_next_segment( reset );
289
333
 
290
334
        // wait till it's time to draw the next segment
291
 
        waitTillEndOfSegment( reset );
 
335
        wait_till_end_of_segment( reset );
292
336
}