/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-05-17 19:17:05 UTC
  • Revision ID: tim@ed.am-20120517191705-3d28d50tw8w51v7g
removed 5V regulator from scematic and replaced the connection to the regulator
on the Arduino -- ecause that's what we should be using and out seperate
regulator is only working around a fault in out arduino

Show diffs side-by-side

added added

removed removed

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