/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.cc

  • Committer: Tim Marston
  • Date: 2012-03-21 19:37:33 UTC
  • Revision ID: tim@ed.am-20120321193733-29euxt0t0h9dwsj3
added .dep directories to bzrignore

Show diffs side-by-side

added added

removed removed

28
28
 
29
29
 * a PC fan is wired up to a 12V power supply
30
30
 
31
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
32
 
   arduino.
 
31
 * the fan's SENSE (tachometer) 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 anf off in unison in the centre of the clock.
 
40
   LEDs that turn on and 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 analog pins 4 and 5.
 
44
 * A DS1307 remote clock is connected via I2C on analogue 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 tachiometer pulses per revolution, so the
 
53
 * a PC fan actually sends 2 tachometer 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 dicsover the position that
 
56
   position. You will need to experiment to discover 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
 
 
79
 
#include <button.h>
80
78
#include "config.h"
 
79
#include "button.h"
81
80
#include "time.h"
82
 
#include "mode_switcher.h"
83
 
#include "drawer.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"
84
89
 
85
90
//_____________________________________________________________________________
86
91
//                                                                         data
87
92
 
88
 
 
89
93
// when non-zero, the time (in microseconds) of a new fan pulse that
90
94
// has just occurred, which means that segment drawing needs to be
91
95
// restarted
92
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
93
97
 
94
98
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
96
100
 
97
101
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
99
103
 
100
104
// remainder after divisor and a tally of the remainders for each segment
101
 
static unsigned long segment_step_sub_step = 0;
102
 
static unsigned long segment_step_sub = 0;
103
 
 
104
 
// flag to indicate that the drawing mode should be cycled to the next one
105
 
static bool inc_draw_mode = false;
106
 
 
107
 
// a bounce-managed button
108
 
static Button button( 3 );
 
105
static unsigned long _segment_step_sub_step = 0;
 
106
static unsigned long _segment_step_sub = 0;
 
107
 
 
108
// 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
109
121
 
110
122
//_____________________________________________________________________________
111
123
//                                                                         code
112
124
 
113
125
 
114
 
// check for button presses
115
 
void checkButtons()
116
 
{
117
 
        // update buttons
118
 
        int event = button.update();
119
 
 
120
 
        // handle any events
121
 
        switch( event ) {
122
 
        case 1:
123
 
                inc_draw_mode = true;
124
 
                break;
125
 
        }
126
 
}
127
 
 
128
 
 
129
 
// turn an led on/off
130
 
void ledOn( int num, bool on )
131
 
{
132
 
        if( num < 0 || num > 9 ) return;
133
 
 
134
 
        // convert to pin no.
135
 
        num += 4;
136
 
 
137
 
        // pin 4 needs to be inverted (it's driving a PNP)
138
 
        if( num == 4 ) on = !on;
139
 
 
140
 
        digitalWrite( num, on? HIGH : LOW );
 
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
                }
 
194
        }
141
195
}
142
196
 
143
197
 
144
198
// draw a display segment
145
 
void drawNextSegment( bool reset )
 
199
void draw_next_segment( bool reset )
146
200
{
147
 
        static ModeSwitcher mode_switcher;
148
 
        static bool init = false;
149
 
 
150
 
        if( !init ) {
151
 
                init = true;
152
 
                mode_switcher.activate();
153
 
        }
154
 
 
155
201
        // keep track of segment
156
202
#if CLOCK_FORWARD
157
203
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
161
207
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
162
208
#endif
163
209
 
 
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
 
164
229
        // draw
165
 
        Drawer &drawer = mode_switcher.get_drawer();
166
 
        if( reset ) drawer.draw_reset();
167
 
        drawer.draw( segment );
 
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();
168
243
 
169
244
#if CLOCK_FORWARD
170
245
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
175
250
 
176
251
 
177
252
// calculate time constants when a new pulse has occurred
178
 
void calculateSegmentTimes()
 
253
void calculate_segment_times()
179
254
{
180
255
        // check for overflows, and only recalculate times if there isn't
181
256
        // one (if there is, we'll just go with the last pulse's times)
182
 
        if( new_pulse_at > last_pulse_at )
 
257
        if( _new_pulse_at > _last_pulse_at )
183
258
        {
184
259
                // new segment stepping times
185
 
                unsigned long delta = new_pulse_at - last_pulse_at;
186
 
                segment_step = delta / NUM_SEGMENTS;
187
 
                segment_step_sub = 0;
188
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
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;
189
264
        }
190
265
 
191
266
        // now we have dealt with this pulse, save the pulse time and
192
267
        // clear new_pulse_at, ready for the next pulse
193
 
        last_pulse_at = new_pulse_at;
194
 
        new_pulse_at = 0;
 
268
        _last_pulse_at = _new_pulse_at;
 
269
        _new_pulse_at = 0;
195
270
}
196
271
 
197
272
 
198
273
// wait until it is time to draw the next segment or a new pulse has
199
274
// occurred
200
 
void waitTillNextSegment( bool reset )
 
275
void wait_till_end_of_segment( bool reset )
201
276
{
202
277
        static unsigned long end_time = 0;
203
278
 
204
279
        // handle reset
205
280
        if( reset )
206
 
                end_time = last_pulse_at;
 
281
                end_time = _last_pulse_at;
207
282
 
208
283
        // work out the time that this segment should be displayed until
209
 
        end_time += segment_step;
210
 
        segment_step_sub += segment_step_sub_step;
211
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
212
 
                segment_step_sub -= NUM_SEGMENTS;
 
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;
213
288
                end_time++;
214
289
        }
215
290
 
216
291
        // wait
217
 
        while( micros() < end_time && !new_pulse_at );
 
292
        while( micros() < end_time && !_new_pulse_at );
218
293
}
219
294
 
220
295
 
221
296
// ISR to handle the pulses from the fan's tachiometer
222
 
void fanPulseHandler()
 
297
void fan_pulse_handler()
223
298
{
224
299
        // the fan actually sends two pulses per revolution. These pulses
225
300
        // may not be exactly evenly distributed around the rotation, so
230
305
        if( !ignore )
231
306
        {
232
307
                // set a new pulse time
233
 
                new_pulse_at = micros();
 
308
                _new_pulse_at = micros();
234
309
        }
235
310
}
236
311
 
239
314
void setup()
240
315
{
241
316
        // set up an interrupt handler on pin 2 to nitice fan pulses
242
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
317
        attachInterrupt( 0, fan_pulse_handler, RISING );
243
318
        digitalWrite( 2, HIGH );
244
319
  
245
320
        // set up output pins (4 to 13) for the led array
249
324
        // set up mode-switch button on pin 3
250
325
        pinMode( 3, INPUT );
251
326
        digitalWrite( 3, HIGH );
252
 
        button.add_event_at( 5, 1 );
253
 
        button.add_event_at( 1000, 2 );
254
 
        button.add_event_at( 4000, 3 );
255
 
 
256
 
        // serial comms
257
 
        Serial.begin( 9600 );
 
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();
258
335
}
259
336
 
260
337
 
262
339
void loop()
263
340
{
264
341
        // if there has been a new pulse, we'll be resetting the display
265
 
        bool reset = new_pulse_at? true : false;
 
342
        bool reset = _new_pulse_at? true : false;
 
343
 
 
344
        // update button
 
345
        _button.update();
266
346
 
267
347
        // only do this stuff at the start of a display cycle, to ensure
268
348
        // that no state changes mid-display
269
349
        if( reset )
270
350
        {
271
 
                // check buttons
272
 
                checkButtons();
 
351
                // calculate segment times
 
352
                calculate_segment_times();
273
353
 
274
354
                // keep track of time
275
 
                Time &time = Time::get_instance();
276
 
                time.update();
 
355
                Time::update();
 
356
 
 
357
                // perform button events
 
358
                do_button_events();
277
359
        }
278
360
 
279
361
        // draw this segment
280
 
        drawNextSegment( reset );
281
 
 
282
 
        // do we need to recalculate segment times?
283
 
        if( reset )
284
 
                calculateSegmentTimes();
 
362
        draw_next_segment( reset );
285
363
 
286
364
        // wait till it's time to draw the next segment
287
 
        waitTillNextSegment( reset );
 
365
        wait_till_end_of_segment( reset );
288
366
}