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