/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-05-17 22:49:36 UTC
  • Revision ID: tim@ed.am-20120517224936-0wgyem932dlq5bs4
various tweaks, a (failed) attempt to fix text reset bug and added TODO

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