/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-23 23:02:50 UTC
  • Revision ID: tim@ed.am-20120523230250-3pls2u6zt3av0uam
fixed text glitch; extended all modes; added screen flip super-long press;
added button unpress debounde; moved interim button press ignoration to
settings mode; fixed left-over led issue; finished for demo!

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "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 "modes/switcher_major_mode.h"
 
83
#include "modes/settings_major_mode.h"
 
84
#include "modes/analogue_clock_mode.h"
 
85
#include "modes/digital_clock_mode.h"
 
86
#include "modes/info_mode.h"
 
87
#include "modes/test_pattern_mode.h"
 
88
#include "text.h"
 
89
#include "text_renderer.h"
 
90
#include "common.h"
81
91
 
82
92
//_____________________________________________________________________________
83
93
//                                                                         data
84
94
 
85
 
 
86
95
// when non-zero, the time (in microseconds) of a new fan pulse that
87
96
// has just occurred, which means that segment drawing needs to be
88
97
// restarted
89
 
static unsigned long new_pulse_at = 0;
 
98
static unsigned long _new_pulse_at = 0;
90
99
 
91
100
// the time (in microseconds) when the last fan pulse occurred
92
 
static unsigned long last_pulse_at = 0;
 
101
static unsigned long _last_pulse_at = 0;
93
102
 
94
103
// duration (in microseconds) that a segment should be displayed
95
 
static unsigned long segment_step = 0;
 
104
static unsigned long _segment_step = 0;
96
105
 
97
106
// 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, 5 );
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 )
 
107
static unsigned long _segment_step_sub_step = 0;
 
108
static unsigned long _segment_step_sub = 0;
 
109
 
 
110
// the button
 
111
static Button _button( 3 );
 
112
 
 
113
// major modes
 
114
static MajorMode *_modes[ 3 ];
 
115
 
 
116
// current major mode
 
117
static int _mode = 0;
 
118
 
 
119
// interupt handler's "ignore every other" flag
 
120
static bool _pulse_ignore = true;
116
121
 
117
122
//_____________________________________________________________________________
118
123
//                                                                         code
119
124
 
120
 
 
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;
 
125
// perform button events
 
126
void do_button_events()
 
127
{
 
128
        // loop through pending events
 
129
        while( int event = _button.get_event() )
 
130
        {
 
131
                switch( event )
 
132
                {
 
133
                case 1:
 
134
                        // short press
 
135
                        _modes[ _mode ]->press();
 
136
                        break;
 
137
                case 2:
 
138
                        // long press
 
139
                        _modes[ _mode ]->long_press();
 
140
                        break;
 
141
                case 3:
 
142
                        // looooong press (change major mode)
 
143
                        _modes[ _mode ]->deactivate();
 
144
                        if( !_modes[ ++_mode ] ) _mode = 0;
 
145
                        _modes[ _mode ]->activate();
 
146
                        break;
 
147
                case 4:
 
148
                        // switch display upside-down
 
149
                        _pulse_ignore = !_pulse_ignore;
 
150
                        break;
158
151
                }
159
152
        }
160
153
}
161
154
 
162
155
 
163
 
// draw a segment for the test display
164
 
void drawNextSegment_test( bool reset )
 
156
// draw a display segment
 
157
void draw_next_segment( bool reset )
165
158
{
166
159
        // keep track of segment
167
 
        static unsigned int segment = 0;
168
 
        if( reset ) segment = 0;
169
 
        segment++;
170
 
 
171
 
        // turn on inside and outside LEDs
172
 
        digitalWrite( 4, HIGH );
173
 
        digitalWrite( 13, HIGH );
174
 
 
175
 
        // display segment number in binary across in the inside LEDs,
176
 
        // with the LED on pin 12 showing the least-significant bit
177
 
        for( int a = 0; a < 8; a++ )
178
 
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
179
 
}
180
 
 
181
 
 
182
 
// draw a segment for the time display
183
 
void drawNextSegment_time( bool reset )
184
 
{
185
 
        static unsigned int second = 0;
186
 
        static unsigned int segment = 0;
187
 
 
188
 
        // handle display reset
189
 
        if( reset ) {
190
 
                second = 0;
191
 
                segment = 0;
192
 
        }
193
 
 
194
 
        // what needs to be drawn?
195
 
        bool draw_tick = !segment && second % 5 == 0;
196
 
        bool draw_second = !segment && second == time_seconds;
197
 
        bool draw_minute = !segment && second == time_minutes;
198
 
        bool draw_hour = !segment && second == time_hours;
199
 
 
200
 
        // set the LEDs
201
 
        digitalWrite( 13, HIGH );
202
 
        digitalWrite( 12, draw_tick || draw_minute );
203
 
        for( int a = 10; a <= 11; a++ )
204
 
                digitalWrite( a, draw_minute || draw_second );
205
 
        for( int a = 4; a <= 9; a++ )
206
 
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
207
 
 
208
 
        // inc position
209
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
210
 
                segment = 0;
211
 
                second++;
212
 
        }
213
 
}
214
 
 
215
 
 
216
 
// draw a display segment
217
 
void drawNextSegment( bool reset )
218
 
{
219
 
        static int draw_mode = 0;
220
 
 
221
 
        // handle mode switch requests
222
 
        if( reset && inc_draw_mode ) {
223
 
                inc_draw_mode = false;
224
 
                draw_mode++;
225
 
                if( draw_mode >= 2 )
226
 
                        draw_mode = 0;
227
 
        }
228
 
 
229
 
        // draw the segment
230
 
        switch( draw_mode ) {
231
 
        case 0: drawNextSegment_test( reset ); break;
232
 
        case 1: drawNextSegment_time( reset ); break;
233
 
        }
 
160
        static int segment = 0;
 
161
#if CLOCK_FORWARD
 
162
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
163
#else
 
164
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
165
#endif
 
166
 
 
167
        // reset the text renderer's buffer
 
168
        TextRenderer::reset_buffer();
 
169
 
 
170
        if( reset )
 
171
        {
 
172
                _modes[ _mode ]->draw_reset();
 
173
 
 
174
                // tell the text services we're starting a new frame
 
175
                Text::draw_reset();
 
176
        }
 
177
 
 
178
        // draw
 
179
        _modes[ _mode ]->draw( segment );
 
180
 
 
181
        // draw text
 
182
        Text::draw( segment );
 
183
 
 
184
        // draw text rednerer's buffer
 
185
        TextRenderer::output_buffer();
 
186
 
 
187
#if CLOCK_FORWARD
 
188
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
189
#else
 
190
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
191
#endif
234
192
}
235
193
 
236
194
 
237
195
// calculate time constants when a new pulse has occurred
238
 
void calculateSegmentTimes()
 
196
void calculate_segment_times()
239
197
{
240
198
        // check for overflows, and only recalculate times if there isn't
241
199
        // one (if there is, we'll just go with the last pulse's times)
242
 
        if( new_pulse_at > last_pulse_at )
 
200
        if( _new_pulse_at > _last_pulse_at )
243
201
        {
244
202
                // new segment stepping times
245
 
                unsigned long delta = new_pulse_at - last_pulse_at;
246
 
                segment_step = delta / NUM_SEGMENTS;
247
 
                segment_step_sub = 0;
248
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
203
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
204
                _segment_step = delta / NUM_SEGMENTS;
 
205
                _segment_step_sub = 0;
 
206
                _segment_step_sub_step = delta % NUM_SEGMENTS;
249
207
        }
250
208
 
251
209
        // now we have dealt with this pulse, save the pulse time and
252
210
        // clear new_pulse_at, ready for the next pulse
253
 
        last_pulse_at = new_pulse_at;
254
 
        new_pulse_at = 0;
 
211
        _last_pulse_at = _new_pulse_at;
 
212
        _new_pulse_at = 0;
255
213
}
256
214
 
257
215
 
258
216
// wait until it is time to draw the next segment or a new pulse has
259
217
// occurred
260
 
void waitTillNextSegment( bool reset )
 
218
void wait_till_end_of_segment( bool reset )
261
219
{
262
220
        static unsigned long end_time = 0;
263
221
 
264
222
        // handle reset
265
223
        if( reset )
266
 
                end_time = last_pulse_at;
 
224
                end_time = _last_pulse_at;
267
225
 
268
226
        // work out the time that this segment should be displayed until
269
 
        end_time += segment_step;
270
 
        segment_step_sub += segment_step_sub_step;
271
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
272
 
                segment_step_sub -= NUM_SEGMENTS;
 
227
        end_time += _segment_step;
 
228
        _segment_step_sub += _segment_step_sub_step;
 
229
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
230
                _segment_step_sub -= NUM_SEGMENTS;
273
231
                end_time++;
274
232
        }
275
233
 
276
234
        // wait
277
 
        while( micros() < end_time && !new_pulse_at );
 
235
        while( micros() < end_time && !_new_pulse_at );
278
236
}
279
237
 
280
238
 
281
 
// ISR to handle the pulses from the fan's tachiometer
282
 
void fanPulseHandler()
 
239
// ISR to handle the pulses from the fan's tachometer
 
240
void fan_pulse_handler()
283
241
{
284
242
        // the fan actually sends two pulses per revolution. These pulses
285
243
        // may not be exactly evenly distributed around the rotation, so
286
244
        // we can't recalculate times on every pulse. Instead, we ignore
287
245
        // every other pulse so timings are based on a complete rotation.
288
 
        static bool ignore = true;
289
 
        ignore = !ignore;
290
 
        if( !ignore )
 
246
        _pulse_ignore = !_pulse_ignore;
 
247
        if( !_pulse_ignore )
291
248
        {
292
249
                // set a new pulse time
293
 
                new_pulse_at = micros();
 
250
                _new_pulse_at = micros();
294
251
        }
295
252
}
296
253
 
298
255
// main setup
299
256
void setup()
300
257
{
301
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
302
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
258
        // set up an interrupt handler on pin 2 to notice fan pulses
 
259
        attachInterrupt( 0, fan_pulse_handler, RISING );
303
260
        digitalWrite( 2, HIGH );
304
261
  
305
262
        // set up output pins (4 to 13) for the led array
308
265
 
309
266
        // set up mode-switch button on pin 3
310
267
        pinMode( 3, INPUT );
311
 
 
312
 
        // get the time from the real-time clock
313
 
        int rtc_data[ 7 ];
314
 
        RTC.get( rtc_data, true );
315
 
        time_hours = rtc_data[ DS1307_HR ];
316
 
        time_minutes = rtc_data[ DS1307_MIN ];
317
 
        time_seconds = rtc_data[ DS1307_SEC ];
318
 
 
319
 
        // serial comms
320
 
        Serial.begin( 9600 );
 
268
        digitalWrite( 3, HIGH );
 
269
        static int event_times[] = { 10, 500, 2000, 4000, 0 };
 
270
        _button.set_event_times( event_times );
 
271
 
 
272
        // initialise RTC
 
273
        Time::load_time();
 
274
 
 
275
        // init text renderer
 
276
        TextRenderer::init();
 
277
 
 
278
        // reset text
 
279
        Text::reset();
 
280
        leds_off();
 
281
 
 
282
        static SwitcherMajorMode switcher;
 
283
        static SettingsMajorMode settings( _button );
 
284
 
 
285
        // add major modes
 
286
        int mode = 0;
 
287
        _modes[ mode++ ] = &switcher;
 
288
        _modes[ mode++ ] = &settings;
 
289
        _modes[ mode ] = 0;
 
290
 
 
291
        // activate the current major mode
 
292
        _modes[ _mode ]->activate();
321
293
}
322
294
 
323
295
 
325
297
void loop()
326
298
{
327
299
        // if there has been a new pulse, we'll be resetting the display
328
 
        bool reset = new_pulse_at? true : false;
 
300
        bool reset = _new_pulse_at? true : false;
 
301
 
 
302
        // update button
 
303
        _button.update();
329
304
 
330
305
        // only do this stuff at the start of a display cycle, to ensure
331
306
        // that no state changes mid-display
332
307
        if( reset )
333
308
        {
334
 
                // check buttons
335
 
                checkButtons();
 
309
                // calculate segment times
 
310
                calculate_segment_times();
336
311
 
337
312
                // keep track of time
338
 
                trackTime();
 
313
                Time::update();
 
314
 
 
315
                // perform button events
 
316
                do_button_events();
339
317
        }
340
318
 
341
319
        // draw this segment
342
 
        drawNextSegment( reset );
343
 
 
344
 
        // do we need to recalculate segment times?
345
 
        if( reset )
346
 
                calculateSegmentTimes();
 
320
        draw_next_segment( reset );
347
321
 
348
322
        // wait till it's time to draw the next segment
349
 
        waitTillNextSegment( reset );
 
323
        wait_till_end_of_segment( reset );
350
324
}