/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-21 20:35:28 UTC
  • Revision ID: tim@ed.am-20120321203528-wfhpych1tub75rgj
fixed bug initialising text services on mode activation

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