/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-28 16:50:26 UTC
  • Revision ID: edam@waxworlds.org-20120228165026-pwnwo300xx2e2kg6
removed ulibc, fixed button, added text rendering

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