/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-09 20:53:26 UTC
  • Revision ID: tim@ed.am-20120509205326-23nmnh3i05hotlro
moved modes to a subdirectory

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 "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
        // 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
        // reset buttons
 
149
        _button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
 
150
 
 
151
        // give the mode a chance to init
 
152
        switch( _major_mode ) {
 
153
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
154
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
 
155
        }
 
156
}
 
157
 
 
158
 
 
159
// perform button events
 
160
void do_button_events()
 
161
{
 
162
        // loop through pending events
 
163
        while( int event = _button.get_event() )
 
164
        {
 
165
                switch( event )
 
166
                {
 
167
                case 1:
 
168
                        // short press
 
169
                        switch( _major_mode ) {
 
170
                        case MAIN_MODE_IDX:
 
171
                                switch( _minor_mode ) {
 
172
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
173
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
174
                                }
 
175
                                break;
 
176
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
 
177
                        }
 
178
                        break;
 
179
 
 
180
                case 2:
 
181
                        // long press
 
182
                        switch( _major_mode ) {
 
183
                        case MAIN_MODE_IDX:
 
184
                                if( ++_minor_mode >= 3 )
 
185
                                        _minor_mode = 0;
 
186
                                activate_minor_mode();
 
187
                                break;
 
188
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
 
189
                        }
 
190
                        break;
 
191
 
 
192
                case 3:
 
193
                        // looooong press (change major mode)
 
194
                        if( ++_major_mode > 1 )
 
195
                                _major_mode = 0;
 
196
                        activate_major_mode();
 
197
                        break;
162
198
                }
163
199
        }
164
200
}
165
201
 
166
202
 
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
203
// draw a display segment
220
 
void drawNextSegment( bool reset )
 
204
void draw_next_segment( bool reset )
221
205
{
222
 
        static int draw_mode = 0;
223
 
 
224
206
        // keep track of segment
225
207
#if CLOCK_FORWARD
226
 
        static int segment = 0;
227
 
        if( reset ) segment = 0;
 
208
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
209
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
228
210
#else
229
 
        static int segment = NUM_SEGMENTS - 1;
230
 
        if( reset ) segment = NUM_SEGMENTS - 1;
 
211
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
212
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
231
213
#endif
232
214
 
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
 
        }
 
215
        // reset the text renderer
 
216
        TextRenderer::reset_buffer();
 
217
 
 
218
        // frame reset
 
219
        if( reset ) {
 
220
                switch( _major_mode ) {
 
221
                case MAIN_MODE_IDX:
 
222
                        switch( _minor_mode ) {
 
223
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
224
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
225
                        }
 
226
                        break;
 
227
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
 
228
                }
 
229
 
 
230
                // tell the text services we're starting a new frame
 
231
                Text::draw_reset();
 
232
        }
 
233
 
 
234
        // draw
 
235
        switch( _major_mode ) {
 
236
        case MAIN_MODE_IDX:
 
237
                switch( _minor_mode ) {
 
238
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
239
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
240
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
241
                }
 
242
                break;
 
243
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
 
244
        }
 
245
 
 
246
        // draw any text that was rendered
 
247
        TextRenderer::output_buffer();
246
248
 
247
249
#if CLOCK_FORWARD
248
 
        segment++;
 
250
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
249
251
#else
250
 
        segment--;
 
252
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
251
253
#endif
252
254
}
253
255
 
254
256
 
255
257
// calculate time constants when a new pulse has occurred
256
 
void calculateSegmentTimes()
 
258
void calculate_segment_times()
257
259
{
258
260
        // check for overflows, and only recalculate times if there isn't
259
261
        // one (if there is, we'll just go with the last pulse's times)
260
 
        if( new_pulse_at > last_pulse_at )
 
262
        if( _new_pulse_at > _last_pulse_at )
261
263
        {
262
264
                // 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;
 
265
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
266
                _segment_step = delta / NUM_SEGMENTS;
 
267
                _segment_step_sub = 0;
 
268
                _segment_step_sub_step = delta % NUM_SEGMENTS;
267
269
        }
268
270
 
269
271
        // now we have dealt with this pulse, save the pulse time and
270
272
        // clear new_pulse_at, ready for the next pulse
271
 
        last_pulse_at = new_pulse_at;
272
 
        new_pulse_at = 0;
 
273
        _last_pulse_at = _new_pulse_at;
 
274
        _new_pulse_at = 0;
273
275
}
274
276
 
275
277
 
276
278
// wait until it is time to draw the next segment or a new pulse has
277
279
// occurred
278
 
void waitTillNextSegment( bool reset )
 
280
void wait_till_end_of_segment( bool reset )
279
281
{
280
282
        static unsigned long end_time = 0;
281
283
 
282
284
        // handle reset
283
285
        if( reset )
284
 
                end_time = last_pulse_at;
 
286
                end_time = _last_pulse_at;
285
287
 
286
288
        // 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;
 
289
        end_time += _segment_step;
 
290
        _segment_step_sub += _segment_step_sub_step;
 
291
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
292
                _segment_step_sub -= NUM_SEGMENTS;
291
293
                end_time++;
292
294
        }
293
295
 
294
296
        // wait
295
 
        while( micros() < end_time && !new_pulse_at );
 
297
        while( micros() < end_time && !_new_pulse_at );
296
298
}
297
299
 
298
300
 
299
301
// ISR to handle the pulses from the fan's tachiometer
300
 
void fanPulseHandler()
 
302
void fan_pulse_handler()
301
303
{
302
304
        // the fan actually sends two pulses per revolution. These pulses
303
305
        // may not be exactly evenly distributed around the rotation, so
308
310
        if( !ignore )
309
311
        {
310
312
                // set a new pulse time
311
 
                new_pulse_at = micros();
 
313
                _new_pulse_at = micros();
312
314
        }
313
315
}
314
316
 
317
319
void setup()
318
320
{
319
321
        // set up an interrupt handler on pin 2 to nitice fan pulses
320
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
322
        attachInterrupt( 0, fan_pulse_handler, RISING );
321
323
        digitalWrite( 2, HIGH );
322
324
  
323
325
        // set up output pins (4 to 13) for the led array
327
329
        // set up mode-switch button on pin 3
328
330
        pinMode( 3, INPUT );
329
331
        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 );
 
332
        static int event_times[] = { 5, 500, 4000, 0 };
 
333
        _button.set_event_times( event_times );
 
334
 
 
335
        // initialise RTC
 
336
        Time::init();
 
337
 
 
338
        // init text renderer
 
339
        TextRenderer::init();
 
340
 
 
341
        // activate the minor mode
 
342
        activate_major_mode();
340
343
}
341
344
 
342
345
 
344
347
void loop()
345
348
{
346
349
        // if there has been a new pulse, we'll be resetting the display
347
 
        bool reset = new_pulse_at? true : false;
 
350
        bool reset = _new_pulse_at? true : false;
 
351
 
 
352
        // update button
 
353
        _button.update();
348
354
 
349
355
        // only do this stuff at the start of a display cycle, to ensure
350
356
        // that no state changes mid-display
351
357
        if( reset )
352
358
        {
353
 
                // check buttons
354
 
                checkButtons();
 
359
                // calculate segment times
 
360
                calculate_segment_times();
355
361
 
356
362
                // keep track of time
357
 
                trackTime();
 
363
                Time::update();
 
364
 
 
365
                // perform button events
 
366
                do_button_events();
358
367
        }
359
368
 
360
369
        // draw this segment
361
 
        drawNextSegment( reset );
362
 
 
363
 
        // do we need to recalculate segment times?
364
 
        if( reset )
365
 
                calculateSegmentTimes();
 
370
        draw_next_segment( reset );
366
371
 
367
372
        // wait till it's time to draw the next segment
368
 
        waitTillNextSegment( reset );
 
373
        wait_till_end_of_segment( reset );
369
374
}