/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

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