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