/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

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