/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-03-03 10:06:31 UTC
  • Revision ID: edam@waxworlds.org-20120303100631-ae3idks1703vdm05
widenned clock hands, tweaked scales, got top & bottom text modes working

Show diffs side-by-side

added added

removed removed

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