/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-09 23:42:20 UTC
  • Revision ID: tim@ed.am-20120309234220-xr1vxzve0o5n2oss
added support for eclipse project and converted to a manual Makefile

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