/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 22:49:11 UTC
  • Revision ID: tim@ed.am-20120517224911-dbd9dtcpl14xlhi0
rewrote/fixed button event triggering code

Show diffs side-by-side

added added

removed removed

src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
1
2
/*
2
3
 * propeller-clock.ino
3
4
 *
27
28
 
28
29
 * a PC fan is wired up to a 12V power supply
29
30
 
30
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
31
 
   arduino.
 
31
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
 
32
   Arduino.
32
33
 
33
 
 * 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
34
35
   LED on pin 4 is in the centre of the clock face and the LED on pin
35
36
   13 is at the outside.
36
37
 
37
38
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
38
 
   used to indirectly drive (via a MOSFET) multiple LEDs which turn on
39
 
   and off in unison in the centre of the clock.
 
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
41
 
41
42
 * a button should be attached to pin 3 that grounds it when pressed.
42
43
 
 
44
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
 
45
 
43
46
Implementation details:
44
47
 
45
 
 * for a schematic, see project/propeller-clock.sch.
 
48
 * for a schematic, see ../project/propeller-clock.sch.
46
49
 
47
50
 * the timing of the drawing of the clock face is recalculated with
48
51
   every rotation of the propeller.
49
52
    
50
 
 * 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
51
54
   software skips every other one. This means that the clock may
52
55
   appear upside-down if started with the propeller in the wrong
53
 
   position. You will need to experiment to dicsover the position that
 
56
   position. You will need to experiment to discover the position that
54
57
   the propeller must be in when starting the clock.
55
58
    
56
59
Usage instructions:
67
70
    - pressing the button increments the field currently being set
68
71
    - pressing and holding the button for a second cycles through the
69
72
      fields that can be set
70
 
    - press and holding the button for 5 seconds to finish
 
73
    - pressing and holding the button for 5 seconds sets the time and
 
74
      exits "time set" mode
71
75
 
72
76
******************************************************************************/
73
77
 
74
 
 
75
 
#include <Bounce.h>
 
78
#include "config.h"
 
79
#include "button.h"
 
80
#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"
76
90
 
77
91
//_____________________________________________________________________________
78
92
//                                                                         data
79
93
 
80
 
 
81
94
// when non-zero, the time (in microseconds) of a new fan pulse that
82
95
// has just occurred, which means that segment drawing needs to be
83
96
// restarted
84
 
static unsigned long new_pulse_at = 0;
 
97
static unsigned long _new_pulse_at = 0;
85
98
 
86
99
// the time (in microseconds) when the last fan pulse occurred
87
 
static unsigned long last_pulse_at = 0;
 
100
static unsigned long _last_pulse_at = 0;
88
101
 
89
102
// duration (in microseconds) that a segment should be displayed
90
 
static unsigned long segment_step = 0;
 
103
static unsigned long _segment_step = 0;
91
104
 
92
105
// remainder after divisor and a tally of the remainders for each segment
93
 
static unsigned long segment_step_sub_step = 0;
94
 
static unsigned long segment_step_sub = 0;
95
 
 
96
 
// flag to indicate that the drawing mode should be cycled to the next one
97
 
static bool inc_draw_mode = false;
98
 
 
99
 
// a bounce-managed button
100
 
static Bounce button( 3, 5 );
101
 
 
102
 
// the time
103
 
static int time_hours = 0;
104
 
static int time_minutes = 0;
105
 
static int time_seconds = 0;
106
 
 
107
 
// number of segments in a full display (rotation) is 60 (one per
108
 
// second) times the desired number of sub-divisions of a second
109
 
#define NUM_SECOND_SEGMENTS 5
110
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
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
111
123
 
112
124
//_____________________________________________________________________________
113
125
//                                                                         code
114
126
 
115
127
 
116
 
// check for button presses
117
 
void checkButtons()
118
 
{
119
 
        // update buttons
120
 
        button.update();
121
 
 
122
 
        // notice button presses
123
 
        if( button.risingEdge() )
124
 
                inc_draw_mode = true;
125
 
}
126
 
 
127
 
 
128
 
// keep track of time
129
 
void trackTime()
130
 
{
131
 
        // previous time and any carried-over milliseconds
132
 
        static unsigned long last_time = millis();
133
 
        static unsigned long carry = 0;
134
 
 
135
 
        // how many milliseonds have elapsed since we last checked?
136
 
        unsigned long next_time = millis();
137
 
        unsigned long delta = next_time - last_time + carry;
138
 
 
139
 
        // update the previous time and carried-over milliseconds
140
 
        last_time = next_time;
141
 
        carry = delta % 1000;
142
 
 
143
 
        // add the seconds that have passed to the time
144
 
        time_seconds += delta / 1000;
145
 
        while( time_seconds >= 60 ) {
146
 
                time_seconds -= 60;
147
 
                time_minutes++;
148
 
                if( time_minutes >= 60 ) {
149
 
                        time_minutes -= 60;
150
 
                        time_hours++;
151
 
                        if( time_hours >= 24 )
152
 
                                time_hours -= 24;
 
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;
153
202
                }
154
203
        }
155
204
}
156
205
 
157
206
 
158
 
// draw a segment for the test display
159
 
void drawNextSegment_test( bool reset )
 
207
// draw a display segment
 
208
void draw_next_segment( bool reset )
160
209
{
161
210
        // keep track of segment
162
 
        static unsigned int segment = 0;
163
 
        if( reset ) segment = 0;
164
 
        segment++;
165
 
 
166
 
        // turn on inside and outside LEDs
167
 
        digitalWrite( 4, HIGH );
168
 
        digitalWrite( 13, HIGH );
169
 
 
170
 
        // display segment number in binary across in the inside LEDs,
171
 
        // with the LED on pin 12 showing the least-significant bit
172
 
        for( int a = 0; a < 8; a++ )
173
 
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
174
 
}
175
 
 
176
 
 
177
 
// draw a segment for the time display
178
 
void drawNextSegment_time( bool reset )
179
 
{
180
 
        static unsigned int second = 0;
181
 
        static unsigned int segment = 0;
182
 
 
183
 
        // handle display reset
 
211
#if CLOCK_FORWARD
 
212
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
213
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
214
#else
 
215
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
216
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
217
#endif
 
218
 
 
219
        // reset the text renderer
 
220
        TextRenderer::reset_buffer();
 
221
 
 
222
        // frame reset
184
223
        if( reset ) {
185
 
                second = 0;
186
 
                segment = 0;
187
 
        }
188
 
 
189
 
        // what needs to be drawn?
190
 
        bool draw_tick = !segment && second % 5 == 0;
191
 
        bool draw_second = !segment && second == time_seconds;
192
 
        bool draw_minute = !segment && second == time_minutes;
193
 
        bool draw_hour = !segment && second == time_hours;
194
 
 
195
 
        // set the LEDs
196
 
        digitalWrite( 13, HIGH );
197
 
        digitalWrite( 12, draw_tick || draw_minute );
198
 
        for( int a = 10; a <= 11; a++ )
199
 
                digitalWrite( a, draw_minute || draw_second );
200
 
        for( int a = 4; a <= 9; a++ )
201
 
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
202
 
 
203
 
        // inc position
204
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
205
 
                segment = 0;
206
 
                second++;
207
 
        }
208
 
}
209
 
 
210
 
 
211
 
// draw a display segment
212
 
void drawNextSegment( bool reset )
213
 
{
214
 
        static int draw_mode = 0;
215
 
 
216
 
        // handle mode switch requests
217
 
        if( reset && inc_draw_mode ) {
218
 
                inc_draw_mode = false;
219
 
                draw_mode++;
220
 
                if( draw_mode >= 2 )
221
 
                        draw_mode = 0;
222
 
        }
223
 
 
224
 
        // draw the segment
225
 
        switch( draw_mode ) {
226
 
        case 0: drawNextSegment_test( reset ); break;
227
 
        case 1: drawNextSegment_time( reset ); break;
228
 
        }
 
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
        // 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
 
 
252
        // draw any text that was rendered
 
253
        TextRenderer::output_buffer();
 
254
 
 
255
#if CLOCK_FORWARD
 
256
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
257
#else
 
258
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
259
#endif
229
260
}
230
261
 
231
262
 
232
263
// calculate time constants when a new pulse has occurred
233
 
void calculateSegmentTimes()
 
264
void calculate_segment_times()
234
265
{
235
266
        // check for overflows, and only recalculate times if there isn't
236
267
        // one (if there is, we'll just go with the last pulse's times)
237
 
        if( new_pulse_at > last_pulse_at )
 
268
        if( _new_pulse_at > _last_pulse_at )
238
269
        {
239
270
                // new segment stepping times
240
 
                unsigned long delta = new_pulse_at - last_pulse_at;
241
 
                segment_step = delta / NUM_SEGMENTS;
242
 
                segment_step_sub = 0;
243
 
                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;
244
275
        }
245
276
 
246
277
        // now we have dealt with this pulse, save the pulse time and
247
278
        // clear new_pulse_at, ready for the next pulse
248
 
        last_pulse_at = new_pulse_at;
249
 
        new_pulse_at = 0;
 
279
        _last_pulse_at = _new_pulse_at;
 
280
        _new_pulse_at = 0;
250
281
}
251
282
 
252
283
 
253
284
// wait until it is time to draw the next segment or a new pulse has
254
285
// occurred
255
 
void waitTillNextSegment( bool reset )
 
286
void wait_till_end_of_segment( bool reset )
256
287
{
257
288
        static unsigned long end_time = 0;
258
289
 
259
290
        // handle reset
260
291
        if( reset )
261
 
                end_time = last_pulse_at;
 
292
                end_time = _last_pulse_at;
262
293
 
263
294
        // work out the time that this segment should be displayed until
264
 
        end_time += segment_step;
265
 
        segment_step_sub += segment_step_sub_step;
266
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
267
 
                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;
268
299
                end_time++;
269
300
        }
270
301
 
271
302
        // wait
272
 
        while( micros() < end_time && !new_pulse_at );
 
303
        while( micros() < end_time && !_new_pulse_at );
273
304
}
274
305
 
275
306
 
276
 
// ISR to handle the pulses from the fan's tachiometer
277
 
void fanPulseHandler()
 
307
// ISR to handle the pulses from the fan's tachometer
 
308
void fan_pulse_handler()
278
309
{
279
310
        // the fan actually sends two pulses per revolution. These pulses
280
311
        // may not be exactly evenly distributed around the rotation, so
285
316
        if( !ignore )
286
317
        {
287
318
                // set a new pulse time
288
 
                new_pulse_at = micros();
 
319
                _new_pulse_at = micros();
289
320
        }
290
321
}
291
322
 
293
324
// main setup
294
325
void setup()
295
326
{
296
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
297
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
327
        // set up an interrupt handler on pin 2 to notice fan pulses
 
328
        attachInterrupt( 0, fan_pulse_handler, RISING );
298
329
        digitalWrite( 2, HIGH );
299
330
  
300
331
        // set up output pins (4 to 13) for the led array
303
334
 
304
335
        // set up mode-switch button on pin 3
305
336
        pinMode( 3, INPUT );
306
 
 
307
 
        // serial comms
308
 
        Serial.begin( 9600 );
 
337
        digitalWrite( 3, HIGH );
 
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();
309
349
}
310
350
 
311
351
 
313
353
void loop()
314
354
{
315
355
        // if there has been a new pulse, we'll be resetting the display
316
 
        bool reset = new_pulse_at? true : false;
 
356
        bool reset = _new_pulse_at? true : false;
 
357
 
 
358
        // update button
 
359
        _button.update();
317
360
 
318
361
        // only do this stuff at the start of a display cycle, to ensure
319
362
        // that no state changes mid-display
320
363
        if( reset )
321
364
        {
322
 
                // check buttons
323
 
                checkButtons();
 
365
                // calculate segment times
 
366
                calculate_segment_times();
324
367
 
325
368
                // keep track of time
326
 
                trackTime();
 
369
                Time::update();
 
370
 
 
371
                // perform button events
 
372
                do_button_events();
327
373
        }
328
374
 
329
375
        // draw this segment
330
 
        drawNextSegment( reset );
331
 
 
332
 
        // do we need to recalculate segment times?
333
 
        if( reset )
334
 
                calculateSegmentTimes();
 
376
        draw_next_segment( reset );
335
377
 
336
378
        // wait till it's time to draw the next segment
337
 
        waitTillNextSegment( reset );
 
379
        wait_till_end_of_segment( reset );
338
380
}