/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

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 "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"
 
82
#include "switcher_major_mode.h"
 
83
#include "drawer.h"
89
84
 
90
85
//_____________________________________________________________________________
91
86
//                                                                         data
92
87
 
 
88
 
93
89
// when non-zero, the time (in microseconds) of a new fan pulse that
94
90
// has just occurred, which means that segment drawing needs to be
95
91
// restarted
96
 
static unsigned long _new_pulse_at = 0;
 
92
static unsigned long new_pulse_at = 0;
97
93
 
98
94
// the time (in microseconds) when the last fan pulse occurred
99
 
static unsigned long _last_pulse_at = 0;
 
95
static unsigned long last_pulse_at = 0;
100
96
 
101
97
// duration (in microseconds) that a segment should be displayed
102
 
static unsigned long _segment_step = 0;
 
98
static unsigned long segment_step = 0;
103
99
 
104
100
// 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;
 
101
static unsigned long segment_step_sub_step = 0;
 
102
static unsigned long segment_step_sub = 0;
107
103
 
108
104
// 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
 
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 };
121
114
 
122
115
//_____________________________________________________________________________
123
116
//                                                                         code
124
117
 
125
118
 
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
119
// perform button events
155
 
void do_button_events()
 
120
void doButtonEvents()
156
121
{
157
122
        // loop through pending events
158
 
        while( int event = _button.get_event() )
 
123
        while( int event = button.get_event() )
159
124
        {
160
125
                switch( event )
161
126
                {
162
127
                case 1:
163
128
                        // 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
 
                        }
 
129
                        major_modes[ major_mode ]->press();
173
130
                        break;
174
131
 
175
132
                case 2:
176
133
                        // 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
 
                        }
 
134
                        major_modes[ major_mode ]->long_press();
185
135
                        break;
186
136
 
187
137
                case 3:
188
138
                        // looooong press (change major mode)
189
 
                        if( ++_major_mode > 1 )
190
 
                                _major_mode = 0;
191
 
                        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();
192
144
                        break;
 
145
 
193
146
                }
194
147
        }
195
148
}
196
149
 
197
150
 
198
151
// draw a display segment
199
 
void draw_next_segment( bool reset )
 
152
void drawNextSegment( bool reset )
200
153
{
201
154
        // keep track of segment
202
155
#if CLOCK_FORWARD
207
160
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
208
161
#endif
209
162
 
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
163
        // 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();
 
164
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
 
165
        if( reset ) drawer.draw_reset();
 
166
        drawer.draw( segment );
243
167
 
244
168
#if CLOCK_FORWARD
245
169
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
250
174
 
251
175
 
252
176
// calculate time constants when a new pulse has occurred
253
 
void calculate_segment_times()
 
177
void calculateSegmentTimes()
254
178
{
255
179
        // check for overflows, and only recalculate times if there isn't
256
180
        // one (if there is, we'll just go with the last pulse's times)
257
 
        if( _new_pulse_at > _last_pulse_at )
 
181
        if( new_pulse_at > last_pulse_at )
258
182
        {
259
183
                // 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;
 
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;
264
188
        }
265
189
 
266
190
        // now we have dealt with this pulse, save the pulse time and
267
191
        // clear new_pulse_at, ready for the next pulse
268
 
        _last_pulse_at = _new_pulse_at;
269
 
        _new_pulse_at = 0;
 
192
        last_pulse_at = new_pulse_at;
 
193
        new_pulse_at = 0;
270
194
}
271
195
 
272
196
 
273
197
// wait until it is time to draw the next segment or a new pulse has
274
198
// occurred
275
 
void wait_till_end_of_segment( bool reset )
 
199
void waitTillEndOfSegment( bool reset )
276
200
{
277
201
        static unsigned long end_time = 0;
278
202
 
279
203
        // handle reset
280
204
        if( reset )
281
 
                end_time = _last_pulse_at;
 
205
                end_time = last_pulse_at;
282
206
 
283
207
        // 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;
 
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;
288
212
                end_time++;
289
213
        }
290
214
 
291
215
        // wait
292
 
        while( micros() < end_time && !_new_pulse_at );
 
216
        while( micros() < end_time && !new_pulse_at );
293
217
}
294
218
 
295
219
 
296
220
// ISR to handle the pulses from the fan's tachiometer
297
 
void fan_pulse_handler()
 
221
void fanPulseHandler()
298
222
{
299
223
        // the fan actually sends two pulses per revolution. These pulses
300
224
        // may not be exactly evenly distributed around the rotation, so
305
229
        if( !ignore )
306
230
        {
307
231
                // set a new pulse time
308
 
                _new_pulse_at = micros();
 
232
                new_pulse_at = micros();
309
233
        }
310
234
}
311
235
 
314
238
void setup()
315
239
{
316
240
        // set up an interrupt handler on pin 2 to nitice fan pulses
317
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
241
        attachInterrupt( 0, fanPulseHandler, RISING );
318
242
        digitalWrite( 2, HIGH );
319
243
  
320
244
        // set up output pins (4 to 13) for the led array
325
249
        pinMode( 3, INPUT );
326
250
        digitalWrite( 3, HIGH );
327
251
        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();
 
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();
335
259
}
336
260
 
337
261
 
339
263
void loop()
340
264
{
341
265
        // if there has been a new pulse, we'll be resetting the display
342
 
        bool reset = _new_pulse_at? true : false;
 
266
        bool reset = new_pulse_at? true : false;
343
267
 
344
268
        // update button
345
 
        _button.update();
 
269
        button.update();
346
270
 
347
271
        // only do this stuff at the start of a display cycle, to ensure
348
272
        // that no state changes mid-display
349
273
        if( reset )
350
274
        {
351
275
                // calculate segment times
352
 
                calculate_segment_times();
 
276
                calculateSegmentTimes();
353
277
 
354
278
                // keep track of time
355
 
                Time::update();
 
279
                Time &time = Time::get_instance();
 
280
                time.update();
356
281
 
357
282
                // perform button events
358
 
                do_button_events();
 
283
                doButtonEvents();
359
284
        }
360
285
 
361
286
        // draw this segment
362
 
        draw_next_segment( reset );
 
287
        drawNextSegment( reset );
363
288
 
364
289
        // wait till it's time to draw the next segment
365
 
        wait_till_end_of_segment( reset );
 
290
        waitTillEndOfSegment( reset );
366
291
}