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