/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-12 21:11:20 UTC
  • Revision ID: tim@ed.am-20120312211120-r86cs574yxztgqij
added time set mode, made text renderer's buffer auto reset/output

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
39
   used to indirectly drive a transistor which in turn drives several
39
 
   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.
40
41
 
41
42
 * a button should be attached to pin 3 that grounds it when pressed.
42
43
 
43
 
 * 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.
44
45
 
45
46
Implementation details:
46
47
 
49
50
 * the timing of the drawing of the clock face is recalculated with
50
51
   every rotation of the propeller.
51
52
    
52
 
 * 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
53
54
   software skips every other one. This means that the clock may
54
55
   appear upside-down if started with the propeller in the wrong
55
 
   position. You will need to experiment to dicsover the position that
 
56
   position. You will need to experiment to discover the position that
56
57
   the propeller must be in when starting the clock.
57
58
    
58
59
Usage instructions:
74
75
 
75
76
******************************************************************************/
76
77
 
77
 
 
78
 
#include <Bounce.h>
79
 
#include <DS1307.h>
80
 
#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"
81
89
 
82
90
//_____________________________________________________________________________
83
91
//                                                                         data
84
92
 
85
 
 
86
93
// when non-zero, the time (in microseconds) of a new fan pulse that
87
94
// has just occurred, which means that segment drawing needs to be
88
95
// restarted
89
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
90
97
 
91
98
// the time (in microseconds) when the last fan pulse occurred
92
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
93
100
 
94
101
// duration (in microseconds) that a segment should be displayed
95
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
96
103
 
97
104
// remainder after divisor and a tally of the remainders for each segment
98
 
static unsigned long segment_step_sub_step = 0;
99
 
static unsigned long segment_step_sub = 0;
100
 
 
101
 
// flag to indicate that the drawing mode should be cycled to the next one
102
 
static bool inc_draw_mode = false;
103
 
 
104
 
// a bounce-managed button
105
 
static Bounce button( 3, 50 );
106
 
 
107
 
// the time
108
 
static int time_hours = 0;
109
 
static int time_minutes = 0;
110
 
static int time_seconds = 0;
111
 
 
112
 
// number of segments in a full display (rotation) is 60 (one per
113
 
// second) times the desired number of sub-divisions of a second
114
 
#define NUM_SECOND_SEGMENTS 5
115
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
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
116
121
 
117
122
//_____________________________________________________________________________
118
123
//                                                                         code
119
124
 
120
125
 
121
 
// check for button presses
122
 
void checkButtons()
123
 
{
124
 
        // update buttons
125
 
        button.update();
126
 
 
127
 
        // notice button presses
128
 
        if( button.risingEdge() )
129
 
                inc_draw_mode = true;
130
 
}
131
 
 
132
 
 
133
 
// keep track of time
134
 
void trackTime()
135
 
{
136
 
        // previous time and any carried-over milliseconds
137
 
        static unsigned long last_time = millis();
138
 
        static unsigned long carry = 0;
139
 
 
140
 
        // how many milliseonds have elapsed since we last checked?
141
 
        unsigned long next_time = millis();
142
 
        unsigned long delta = next_time - last_time + carry;
143
 
 
144
 
        // update the previous time and carried-over milliseconds
145
 
        last_time = next_time;
146
 
        carry = delta % 1000;
147
 
 
148
 
        // add the seconds that have passed to the time
149
 
        time_seconds += delta / 1000;
150
 
        while( time_seconds >= 60 ) {
151
 
                time_seconds -= 60;
152
 
                time_minutes++;
153
 
                if( time_minutes >= 60 ) {
154
 
                        time_minutes -= 60;
155
 
                        time_hours++;
156
 
                        if( time_hours >= 24 )
157
 
                                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;
158
193
                }
159
194
        }
160
195
}
161
196
 
162
197
 
163
 
// turn an led on/off
164
 
void ledOn( int num, bool on )
165
 
{
166
 
        if( num < 0 || num > 9 ) return;
167
 
 
168
 
        // convert to pin no.
169
 
        num += 4;
170
 
 
171
 
        // pin 4 needs to be inverted (it's driving a PNP)
172
 
        if( num == 4 ) on = !on;
173
 
 
174
 
        digitalWrite( num, on? HIGH : LOW );
175
 
}
176
 
 
177
 
 
178
 
// draw a segment for the test display
179
 
void drawNextSegment_test( bool reset )
 
198
// draw a display segment
 
199
void draw_next_segment( bool reset )
180
200
{
181
201
        // keep track of segment
182
 
        static unsigned int segment = 0;
183
 
        if( reset ) segment = 0;
184
 
        segment++;
185
 
 
186
 
        // turn on inside and outside LEDs
187
 
        ledOn( 0, true );
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 < 8; a++ )
193
 
                ledOn( 8 - a, ( segment >> a ) & 1 );
194
 
}
195
 
 
196
 
 
197
 
// draw a segment for the time display
198
 
void drawNextSegment_time( bool reset )
199
 
{
200
 
        static int second = 0;
201
 
        static int segment = 0;
202
 
 
203
 
        // handle display reset
 
202
#if CLOCK_FORWARD
 
203
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
204
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
205
#else
 
206
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
207
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
208
#endif
 
209
 
 
210
        // reset the text renderer
 
211
        TextRenderer::reset_buffer();
 
212
 
 
213
        // frame reset
204
214
        if( reset ) {
205
 
                second = 0;
206
 
                segment = 0;
207
 
        }
208
 
 
209
 
        // what needs to be drawn?
210
 
        bool draw_tick = !segment && second % 5 == 0;
211
 
        bool draw_second = !segment && second == time_seconds;
212
 
        bool draw_minute = !segment && second == time_minutes;
213
 
        bool draw_hour = !segment && second == time_hours;
214
 
 
215
 
        // set the LEDs
216
 
        ledOn( 9, true );
217
 
        ledOn( 8, draw_tick || draw_minute );
218
 
        for( int a = 6; a <= 7; a++ )
219
 
                ledOn( a, draw_minute || draw_second );
220
 
        for( int a = 0; a <= 5; a++ )
221
 
                ledOn( a, draw_minute || draw_second || draw_hour );
222
 
 
223
 
        // inc position
224
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
225
 
                segment = 0;
226
 
                second++;
227
 
        }
228
 
}
229
 
 
230
 
 
231
 
// draw a display segment
232
 
void drawNextSegment( bool reset )
233
 
{
234
 
        static int draw_mode = 0;
235
 
 
236
 
        // handle mode switch requests
237
 
        if( reset && inc_draw_mode ) {
238
 
                inc_draw_mode = false;
239
 
                draw_mode++;
240
 
                if( draw_mode >= 2 )
241
 
                        draw_mode = 0;
242
 
        }
243
 
 
244
 
        // draw the segment
245
 
        switch( draw_mode ) {
246
 
        case 0: drawNextSegment_test( reset ); break;
247
 
        case 1: drawNextSegment_time( reset ); break;
248
 
        }
 
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();
 
243
 
 
244
#if CLOCK_FORWARD
 
245
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
246
#else
 
247
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
248
#endif
249
249
}
250
250
 
251
251
 
252
252
// calculate time constants when a new pulse has occurred
253
 
void calculateSegmentTimes()
 
253
void calculate_segment_times()
254
254
{
255
255
        // check for overflows, and only recalculate times if there isn't
256
256
        // one (if there is, we'll just go with the last pulse's times)
257
 
        if( new_pulse_at > last_pulse_at )
 
257
        if( _new_pulse_at > _last_pulse_at )
258
258
        {
259
259
                // new segment stepping times
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;
 
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;
264
264
        }
265
265
 
266
266
        // now we have dealt with this pulse, save the pulse time and
267
267
        // clear new_pulse_at, ready for the next pulse
268
 
        last_pulse_at = new_pulse_at;
269
 
        new_pulse_at = 0;
 
268
        _last_pulse_at = _new_pulse_at;
 
269
        _new_pulse_at = 0;
270
270
}
271
271
 
272
272
 
273
273
// wait until it is time to draw the next segment or a new pulse has
274
274
// occurred
275
 
void waitTillNextSegment( bool reset )
 
275
void wait_till_end_of_segment( bool reset )
276
276
{
277
277
        static unsigned long end_time = 0;
278
278
 
279
279
        // handle reset
280
280
        if( reset )
281
 
                end_time = last_pulse_at;
 
281
                end_time = _last_pulse_at;
282
282
 
283
283
        // work out the time that this segment should be displayed until
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;
 
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;
288
288
                end_time++;
289
289
        }
290
290
 
291
291
        // wait
292
 
        while( micros() < end_time && !new_pulse_at );
 
292
        while( micros() < end_time && !_new_pulse_at );
293
293
}
294
294
 
295
295
 
296
296
// ISR to handle the pulses from the fan's tachiometer
297
 
void fanPulseHandler()
 
297
void fan_pulse_handler()
298
298
{
299
299
        // the fan actually sends two pulses per revolution. These pulses
300
300
        // may not be exactly evenly distributed around the rotation, so
305
305
        if( !ignore )
306
306
        {
307
307
                // set a new pulse time
308
 
                new_pulse_at = micros();
 
308
                _new_pulse_at = micros();
309
309
        }
310
310
}
311
311
 
314
314
void setup()
315
315
{
316
316
        // set up an interrupt handler on pin 2 to nitice fan pulses
317
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
317
        attachInterrupt( 0, fan_pulse_handler, RISING );
318
318
        digitalWrite( 2, HIGH );
319
319
  
320
320
        // set up output pins (4 to 13) for the led array
324
324
        // set up mode-switch button on pin 3
325
325
        pinMode( 3, INPUT );
326
326
        digitalWrite( 3, HIGH );
327
 
 
328
 
        // get the time from the real-time clock
329
 
        int rtc_data[ 7 ];
330
 
        RTC.get( rtc_data, true );
331
 
        time_hours = rtc_data[ DS1307_HR ];
332
 
        time_minutes = rtc_data[ DS1307_MIN ];
333
 
        time_seconds = rtc_data[ DS1307_SEC ];
334
 
 
335
 
        // serial comms
336
 
        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();
337
335
}
338
336
 
339
337
 
341
339
void loop()
342
340
{
343
341
        // if there has been a new pulse, we'll be resetting the display
344
 
        bool reset = new_pulse_at? true : false;
 
342
        bool reset = _new_pulse_at? true : false;
 
343
 
 
344
        // update button
 
345
        _button.update();
345
346
 
346
347
        // only do this stuff at the start of a display cycle, to ensure
347
348
        // that no state changes mid-display
348
349
        if( reset )
349
350
        {
350
 
                // check buttons
351
 
                checkButtons();
 
351
                // calculate segment times
 
352
                calculate_segment_times();
352
353
 
353
354
                // keep track of time
354
 
                trackTime();
 
355
                Time::update();
 
356
 
 
357
                // perform button events
 
358
                do_button_events();
355
359
        }
356
360
 
357
361
        // draw this segment
358
 
        drawNextSegment( reset );
359
 
 
360
 
        // do we need to recalculate segment times?
361
 
        if( reset )
362
 
                calculateSegmentTimes();
 
362
        draw_next_segment( reset );
363
363
 
364
364
        // wait till it's time to draw the next segment
365
 
        waitTillNextSegment( reset );
 
365
        wait_till_end_of_segment( reset );
366
366
}