/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:36 UTC
  • Revision ID: tim@ed.am-20120517224936-0wgyem932dlq5bs4
various tweaks, a (failed) attempt to fix text reset bug and added TODO

Show diffs side-by-side

added added

removed removed

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