/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-09 20:36:07 UTC
  • Revision ID: tim@ed.am-20120509203607-5sh14qikxjmm6p3y
updated arduino.mk

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