/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

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:
75
75
 
76
76
******************************************************************************/
77
77
 
 
78
#include "config.h"
78
79
#include "button.h"
79
 
#include "config.h"
80
80
#include "time.h"
81
 
#include "mode_switcher.h"
82
 
#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"
83
90
 
84
91
//_____________________________________________________________________________
85
92
//                                                                         data
86
93
 
87
 
 
88
94
// when non-zero, the time (in microseconds) of a new fan pulse that
89
95
// has just occurred, which means that segment drawing needs to be
90
96
// restarted
91
 
static unsigned long new_pulse_at = 0;
 
97
static unsigned long _new_pulse_at = 0;
92
98
 
93
99
// the time (in microseconds) when the last fan pulse occurred
94
 
static unsigned long last_pulse_at = 0;
 
100
static unsigned long _last_pulse_at = 0;
95
101
 
96
102
// duration (in microseconds) that a segment should be displayed
97
 
static unsigned long segment_step = 0;
 
103
static unsigned long _segment_step = 0;
98
104
 
99
105
// remainder after divisor and a tally of the remainders for each segment
100
 
static unsigned long segment_step_sub_step = 0;
101
 
static unsigned long segment_step_sub = 0;
 
106
static unsigned long _segment_step_sub_step = 0;
 
107
static unsigned long _segment_step_sub = 0;
102
108
 
103
109
// the button
104
 
static Button button( 3 );
105
 
 
106
 
// major mode
107
 
static int major_mode = 0;
108
 
 
109
 
// major modes
110
 
static std::vector< MajorMode * > major_modes;
 
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
111
123
 
112
124
//_____________________________________________________________________________
113
125
//                                                                         code
114
126
 
115
127
 
116
 
// check for button presses
117
 
void checkButtons()
118
 
{
119
 
        // update buttons
120
 
        int event = button.update();
121
 
 
122
 
        // handle any events
123
 
        switch( event ) {
124
 
        case 1:
125
 
                major_modes[ major_mode ]->short_press();
126
 
                break;
127
 
        case 2:
128
 
                major_modes[ major_mode ]->long_press();
129
 
                break;
130
 
        case 3:
131
 
                if( ++major_mode >= major_modes.size() )
132
 
                        major_mode = 0;
133
 
                major_modes[ major_mode ]->activate();
134
 
                break;
 
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
// perform button events
 
163
void do_button_events()
 
164
{
 
165
        // loop through pending events
 
166
        while( int event = _button.get_event() )
 
167
        {
 
168
                switch( event )
 
169
                {
 
170
                case 1:
 
171
                        // 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
                        }
 
182
                        break;
 
183
 
 
184
                case 2:
 
185
                        // 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
                        }
 
194
                        break;
 
195
 
 
196
                case 3:
 
197
                        // looooong press (change major mode)
 
198
                        if( ++_major_mode > 1 )
 
199
                                _major_mode = 0;
 
200
                        activate_major_mode();
 
201
                        break;
 
202
                }
135
203
        }
136
204
}
137
205
 
138
206
 
139
207
// draw a display segment
140
 
void drawNextSegment( bool reset )
 
208
void draw_next_segment( bool reset )
141
209
{
142
210
        // keep track of segment
143
211
#if CLOCK_FORWARD
148
216
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
149
217
#endif
150
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
 
151
239
        // draw
152
 
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
153
 
        if( reset ) drawer.draw_reset();
154
 
        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();
155
255
 
156
256
#if CLOCK_FORWARD
157
257
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
162
262
 
163
263
 
164
264
// calculate time constants when a new pulse has occurred
165
 
void calculateSegmentTimes()
 
265
void calculate_segment_times()
166
266
{
167
267
        // check for overflows, and only recalculate times if there isn't
168
268
        // one (if there is, we'll just go with the last pulse's times)
169
 
        if( new_pulse_at > last_pulse_at )
 
269
        if( _new_pulse_at > _last_pulse_at )
170
270
        {
171
271
                // new segment stepping times
172
 
                unsigned long delta = new_pulse_at - last_pulse_at;
173
 
                segment_step = delta / NUM_SEGMENTS;
174
 
                segment_step_sub = 0;
175
 
                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;
176
276
        }
177
277
 
178
278
        // now we have dealt with this pulse, save the pulse time and
179
279
        // clear new_pulse_at, ready for the next pulse
180
 
        last_pulse_at = new_pulse_at;
181
 
        new_pulse_at = 0;
 
280
        _last_pulse_at = _new_pulse_at;
 
281
        _new_pulse_at = 0;
182
282
}
183
283
 
184
284
 
185
285
// wait until it is time to draw the next segment or a new pulse has
186
286
// occurred
187
 
void waitTillNextSegment( bool reset )
 
287
void wait_till_end_of_segment( bool reset )
188
288
{
189
289
        static unsigned long end_time = 0;
190
290
 
191
291
        // handle reset
192
292
        if( reset )
193
 
                end_time = last_pulse_at;
 
293
                end_time = _last_pulse_at;
194
294
 
195
295
        // work out the time that this segment should be displayed until
196
 
        end_time += segment_step;
197
 
        segment_step_sub += segment_step_sub_step;
198
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
199
 
                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;
200
300
                end_time++;
201
301
        }
202
302
 
203
303
        // wait
204
 
        while( micros() < end_time && !new_pulse_at );
 
304
        while( micros() < end_time && !_new_pulse_at );
205
305
}
206
306
 
207
307
 
208
 
// ISR to handle the pulses from the fan's tachiometer
209
 
void fanPulseHandler()
 
308
// ISR to handle the pulses from the fan's tachometer
 
309
void fan_pulse_handler()
210
310
{
211
311
        // the fan actually sends two pulses per revolution. These pulses
212
312
        // may not be exactly evenly distributed around the rotation, so
217
317
        if( !ignore )
218
318
        {
219
319
                // set a new pulse time
220
 
                new_pulse_at = micros();
 
320
                _new_pulse_at = micros();
221
321
        }
222
322
}
223
323
 
225
325
// main setup
226
326
void setup()
227
327
{
228
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
229
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
328
        // set up an interrupt handler on pin 2 to notice fan pulses
 
329
        attachInterrupt( 0, fan_pulse_handler, RISING );
230
330
        digitalWrite( 2, HIGH );
231
331
  
232
332
        // set up output pins (4 to 13) for the led array
236
336
        // set up mode-switch button on pin 3
237
337
        pinMode( 3, INPUT );
238
338
        digitalWrite( 3, HIGH );
239
 
        button.add_event_at( 5, 1 );
240
 
        button.add_event_at( 1000, 2 );
241
 
        button.add_event_at( 4000, 3 );
242
 
 
243
 
        // serial comms
244
 
        Serial.begin( 9600 );
245
 
 
246
 
        // set up major modes
247
 
        static ModeSwitcher mode_switcher;
248
 
        major_modes.push_back( &mode_switcher );
249
 
        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();
250
350
}
251
351
 
252
352
 
254
354
void loop()
255
355
{
256
356
        // if there has been a new pulse, we'll be resetting the display
257
 
        bool reset = new_pulse_at? true : false;
 
357
        bool reset = _new_pulse_at? true : false;
 
358
 
 
359
        // update button
 
360
        _button.update();
258
361
 
259
362
        // only do this stuff at the start of a display cycle, to ensure
260
363
        // that no state changes mid-display
261
364
        if( reset )
262
365
        {
263
 
                // check buttons
264
 
                checkButtons();
 
366
                // calculate segment times
 
367
                calculate_segment_times();
265
368
 
266
369
                // keep track of time
267
 
                Time &time = Time::get_instance();
268
 
                time.update();
 
370
                Time::update();
 
371
 
 
372
                // perform button events
 
373
                do_button_events();
269
374
        }
270
375
 
271
376
        // draw this segment
272
 
        drawNextSegment( reset );
273
 
 
274
 
        // do we need to recalculate segment times?
275
 
        if( reset )
276
 
                calculateSegmentTimes();
 
377
        draw_next_segment( reset );
277
378
 
278
379
        // wait till it's time to draw the next segment
279
 
        waitTillNextSegment( reset );
 
380
        wait_till_end_of_segment( reset );
280
381
}