/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.ino

  • Committer: edam
  • Date: 2012-02-25 14:54:33 UTC
  • Revision ID: edam@waxworlds.org-20120225145433-kih8qs45x05cum46
removed Bounce library and updated/fixed new code

Show diffs side-by-side

added added

removed removed

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