/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 20:35:28 UTC
  • Revision ID: tim@ed.am-20120321203528-wfhpych1tub75rgj
fixed bug initialising text services on mode activation

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 <Bounce.h>
80
 
#include <DS1307.h>
81
 
#include <Wire.h>
 
78
#include "config.h"
 
79
#include "button.h"
 
80
#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
89
 
83
90
//_____________________________________________________________________________
84
91
//                                                                         data
85
92
 
86
 
 
87
93
// when non-zero, the time (in microseconds) of a new fan pulse that
88
94
// has just occurred, which means that segment drawing needs to be
89
95
// restarted
90
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
91
97
 
92
98
// the time (in microseconds) when the last fan pulse occurred
93
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
94
100
 
95
101
// duration (in microseconds) that a segment should be displayed
96
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
97
103
 
98
104
// remainder after divisor and a tally of the remainders for each segment
99
 
static unsigned long segment_step_sub_step = 0;
100
 
static unsigned long segment_step_sub = 0;
101
 
 
102
 
// flag to indicate that the drawing mode should be cycled to the next one
103
 
static bool inc_draw_mode = false;
104
 
 
105
 
// a bounce-managed button
106
 
static Bounce button( 3, 50 );
107
 
 
108
 
// the time
109
 
static int time_hours = 0;
110
 
static int time_minutes = 0;
111
 
static int time_seconds = 0;
112
 
 
113
 
// number of segments in a full display (rotation) is 60 (one per
114
 
// second) times the desired number of sub-divisions of a second
115
 
#define NUM_SECOND_SEGMENTS 5
116
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
117
 
 
118
 
// clock draw direction
119
 
#define CLOCK_FORWARD 0
120
 
 
121
 
// rotate display (in segments)
122
 
#define CLOCK_SHIFT ( 58 * NUM_SECOND_SEGMENTS - 1 )
 
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
123
121
 
124
122
//_____________________________________________________________________________
125
123
//                                                                         code
126
124
 
127
125
 
128
 
// check for button presses
129
 
void checkButtons()
130
 
{
131
 
        // update buttons
132
 
        button.update();
133
 
 
134
 
        // notice button presses
135
 
        if( button.risingEdge() )
136
 
                inc_draw_mode = true;
137
 
}
138
 
 
139
 
 
140
 
// keep track of time
141
 
void trackTime()
142
 
{
143
 
        // previous time and any carried-over milliseconds
144
 
        static unsigned long last_time = millis();
145
 
        static unsigned long carry = 0;
146
 
 
147
 
        // how many milliseonds have elapsed since we last checked?
148
 
        unsigned long next_time = millis();
149
 
        unsigned long delta = next_time - last_time + carry;
150
 
 
151
 
        // update the previous time and carried-over milliseconds
152
 
        last_time = next_time;
153
 
        carry = delta % 1000;
154
 
 
155
 
        // add the seconds that have passed to the time
156
 
        time_seconds += delta / 1000;
157
 
        while( time_seconds >= 60 ) {
158
 
                time_seconds -= 60;
159
 
                time_minutes++;
160
 
                if( time_minutes >= 60 ) {
161
 
                        time_minutes -= 60;
162
 
                        time_hours++;
163
 
                        if( time_hours >= 24 )
164
 
                                time_hours -= 24;
 
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
        // give the mode a chance to init
 
149
        switch( _major_mode ) {
 
150
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
151
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
 
152
        }
 
153
}
 
154
 
 
155
 
 
156
// perform button events
 
157
void do_button_events()
 
158
{
 
159
        // loop through pending events
 
160
        while( int event = _button.get_event() )
 
161
        {
 
162
                switch( event )
 
163
                {
 
164
                case 1:
 
165
                        // short press
 
166
                        switch( _major_mode ) {
 
167
                        case MAIN_MODE_IDX:
 
168
                                switch( _minor_mode ) {
 
169
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
170
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
171
                                }
 
172
                                break;
 
173
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
 
174
                        }
 
175
                        break;
 
176
 
 
177
                case 2:
 
178
                        // long press
 
179
                        switch( _major_mode ) {
 
180
                        case MAIN_MODE_IDX:
 
181
                                if( ++_minor_mode >= 3 )
 
182
                                        _minor_mode = 0;
 
183
                                activate_minor_mode();
 
184
                                break;
 
185
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
 
186
                        }
 
187
                        break;
 
188
 
 
189
                case 3:
 
190
                        // looooong press (change major mode)
 
191
                        if( ++_major_mode > 1 )
 
192
                                _major_mode = 0;
 
193
                        activate_major_mode();
 
194
                        break;
165
195
                }
166
196
        }
167
197
}
168
198
 
169
199
 
170
 
// turn an led on/off
171
 
void ledOn( int num, bool on )
172
 
{
173
 
        if( num < 0 || num > 9 ) return;
174
 
 
175
 
        // convert to pin no.
176
 
        num += 4;
177
 
 
178
 
        // pin 4 needs to be inverted (it's driving a PNP)
179
 
        if( num == 4 ) on = !on;
180
 
 
181
 
        digitalWrite( num, on? HIGH : LOW );
182
 
}
183
 
 
184
 
 
185
 
// draw a segment for the test display
186
 
void drawNextSegment_test( int segment )
187
 
{
188
 
        // turn on outside LEDs
189
 
        ledOn( 9, true );
190
 
 
191
 
        // display segment number in binary across in the inside LEDs,
192
 
        // with the LED on pin 12 showing the least-significant bit
193
 
        for( int a = 0; a < 9; a++ )
194
 
                ledOn( 8 - a, ( segment >> a ) & 1 );
195
 
}
196
 
 
197
 
 
198
 
// draw a segment for the time display
199
 
void drawNextSegment_time( int segment )
200
 
{
201
 
        int second = segment / NUM_SECOND_SEGMENTS;
202
 
        int second_segment = segment % NUM_SECOND_SEGMENTS;
203
 
 
204
 
        // what needs to be drawn?
205
 
        bool draw_tick = ( !second_segment && second % 5 == 0 && second ) ||
206
 
                ( second == 0 && second_segment == 1 ) ||
207
 
                ( second == 59 && second_segment == NUM_SECOND_SEGMENTS - 1 );
208
 
        bool draw_second = !second_segment && second == time_seconds;
209
 
        bool draw_minute = !second_segment && second == time_minutes;
210
 
        bool draw_hour = segment == time_hours * 5 * NUM_SECOND_SEGMENTS +
211
 
                ( 5 * NUM_SECOND_SEGMENTS * time_minutes / 60 );
212
 
 
213
 
        // set the LEDs
214
 
        ledOn( 9, true );
215
 
        ledOn( 8, draw_tick || draw_second );
216
 
        for( int a = 6; a <= 7; a++ )
217
 
                ledOn( a, draw_minute || draw_second );
218
 
        for( int a = 0; a <= 5; a++ )
219
 
                ledOn( a, draw_minute || draw_second || draw_hour );
220
 
}
221
 
 
222
 
 
223
200
// draw a display segment
224
 
void drawNextSegment( bool reset )
 
201
void draw_next_segment( bool reset )
225
202
{
226
 
        static int draw_mode = 0;
227
 
 
228
203
        // keep track of segment
229
204
#if CLOCK_FORWARD
230
205
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
234
209
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
235
210
#endif
236
211
 
237
 
        // handle mode switch requests
238
 
        if( reset && inc_draw_mode ) {
239
 
                inc_draw_mode = false;
240
 
                draw_mode++;
241
 
                if( draw_mode >= 2 )
242
 
                        draw_mode = 0;
243
 
        }
244
 
 
245
 
        // draw the segment
246
 
        switch( draw_mode ) {
247
 
        case 0: drawNextSegment_test( segment ); break;
248
 
        case 1: drawNextSegment_time( segment ); break;
249
 
        }
 
212
        // reset the text renderer
 
213
        TextRenderer::reset_buffer();
 
214
 
 
215
        // frame reset
 
216
        if( reset ) {
 
217
                switch( _major_mode ) {
 
218
                case MAIN_MODE_IDX:
 
219
                        switch( _minor_mode ) {
 
220
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
221
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
222
                        }
 
223
                        break;
 
224
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
 
225
                }
 
226
 
 
227
                // tell the text services we're starting a new frame
 
228
                Text::draw_reset();
 
229
        }
 
230
 
 
231
        // draw
 
232
        switch( _major_mode ) {
 
233
        case MAIN_MODE_IDX:
 
234
                switch( _minor_mode ) {
 
235
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
236
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
237
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
238
                }
 
239
                break;
 
240
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
 
241
        }
 
242
 
 
243
        // draw any text that was rendered
 
244
        TextRenderer::output_buffer();
250
245
 
251
246
#if CLOCK_FORWARD
252
247
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
257
252
 
258
253
 
259
254
// calculate time constants when a new pulse has occurred
260
 
void calculateSegmentTimes()
 
255
void calculate_segment_times()
261
256
{
262
257
        // check for overflows, and only recalculate times if there isn't
263
258
        // one (if there is, we'll just go with the last pulse's times)
264
 
        if( new_pulse_at > last_pulse_at )
 
259
        if( _new_pulse_at > _last_pulse_at )
265
260
        {
266
261
                // new segment stepping times
267
 
                unsigned long delta = new_pulse_at - last_pulse_at;
268
 
                segment_step = delta / NUM_SEGMENTS;
269
 
                segment_step_sub = 0;
270
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
262
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
263
                _segment_step = delta / NUM_SEGMENTS;
 
264
                _segment_step_sub = 0;
 
265
                _segment_step_sub_step = delta % NUM_SEGMENTS;
271
266
        }
272
267
 
273
268
        // now we have dealt with this pulse, save the pulse time and
274
269
        // clear new_pulse_at, ready for the next pulse
275
 
        last_pulse_at = new_pulse_at;
276
 
        new_pulse_at = 0;
 
270
        _last_pulse_at = _new_pulse_at;
 
271
        _new_pulse_at = 0;
277
272
}
278
273
 
279
274
 
280
275
// wait until it is time to draw the next segment or a new pulse has
281
276
// occurred
282
 
void waitTillNextSegment( bool reset )
 
277
void wait_till_end_of_segment( bool reset )
283
278
{
284
279
        static unsigned long end_time = 0;
285
280
 
286
281
        // handle reset
287
282
        if( reset )
288
 
                end_time = last_pulse_at;
 
283
                end_time = _last_pulse_at;
289
284
 
290
285
        // work out the time that this segment should be displayed until
291
 
        end_time += segment_step;
292
 
        segment_step_sub += segment_step_sub_step;
293
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
294
 
                segment_step_sub -= NUM_SEGMENTS;
 
286
        end_time += _segment_step;
 
287
        _segment_step_sub += _segment_step_sub_step;
 
288
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
289
                _segment_step_sub -= NUM_SEGMENTS;
295
290
                end_time++;
296
291
        }
297
292
 
298
293
        // wait
299
 
        while( micros() < end_time && !new_pulse_at );
 
294
        while( micros() < end_time && !_new_pulse_at );
300
295
}
301
296
 
302
297
 
303
298
// ISR to handle the pulses from the fan's tachiometer
304
 
void fanPulseHandler()
 
299
void fan_pulse_handler()
305
300
{
306
301
        // the fan actually sends two pulses per revolution. These pulses
307
302
        // may not be exactly evenly distributed around the rotation, so
312
307
        if( !ignore )
313
308
        {
314
309
                // set a new pulse time
315
 
                new_pulse_at = micros();
 
310
                _new_pulse_at = micros();
316
311
        }
317
312
}
318
313
 
321
316
void setup()
322
317
{
323
318
        // set up an interrupt handler on pin 2 to nitice fan pulses
324
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
319
        attachInterrupt( 0, fan_pulse_handler, RISING );
325
320
        digitalWrite( 2, HIGH );
326
321
  
327
322
        // set up output pins (4 to 13) for the led array
331
326
        // set up mode-switch button on pin 3
332
327
        pinMode( 3, INPUT );
333
328
        digitalWrite( 3, HIGH );
334
 
 
335
 
        // get the time from the real-time clock
336
 
        int rtc_data[ 7 ];
337
 
        RTC.get( rtc_data, true );
338
 
        time_hours = rtc_data[ DS1307_HR ];
339
 
        time_minutes = rtc_data[ DS1307_MIN ];
340
 
        time_seconds = rtc_data[ DS1307_SEC ];
341
 
 
342
 
        // serial comms
343
 
        Serial.begin( 9600 );
 
329
        static int event_times[] = { 5, 500, 4000, 0 };
 
330
        _button.set_event_times( event_times );
 
331
 
 
332
        // initialise RTC
 
333
        Time::init();
 
334
 
 
335
        // activate the minor mode
 
336
        activate_major_mode();
344
337
}
345
338
 
346
339
 
348
341
void loop()
349
342
{
350
343
        // if there has been a new pulse, we'll be resetting the display
351
 
        bool reset = new_pulse_at? true : false;
 
344
        bool reset = _new_pulse_at? true : false;
 
345
 
 
346
        // update button
 
347
        _button.update();
352
348
 
353
349
        // only do this stuff at the start of a display cycle, to ensure
354
350
        // that no state changes mid-display
355
351
        if( reset )
356
352
        {
357
 
                // check buttons
358
 
                checkButtons();
 
353
                // calculate segment times
 
354
                calculate_segment_times();
359
355
 
360
356
                // keep track of time
361
 
                trackTime();
 
357
                Time::update();
 
358
 
 
359
                // perform button events
 
360
                do_button_events();
362
361
        }
363
362
 
364
363
        // draw this segment
365
 
        drawNextSegment( reset );
366
 
 
367
 
        // do we need to recalculate segment times?
368
 
        if( reset )
369
 
                calculateSegmentTimes();
 
364
        draw_next_segment( reset );
370
365
 
371
366
        // wait till it's time to draw the next segment
372
 
        waitTillNextSegment( reset );
 
367
        wait_till_end_of_segment( reset );
373
368
}