/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: edam
  • Date: 2012-05-18 12:11:01 UTC
  • Revision ID: tim@ed.am-20120518121101-0wik922hyvjkcjdi
switched back to using classes for modes

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 "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"
82
91
 
83
92
//_____________________________________________________________________________
84
93
//                                                                         data
85
94
 
86
 
 
87
95
// when non-zero, the time (in microseconds) of a new fan pulse that
88
96
// has just occurred, which means that segment drawing needs to be
89
97
// restarted
90
 
static unsigned long new_pulse_at = 0;
 
98
static unsigned long _new_pulse_at = 0;
91
99
 
92
100
// the time (in microseconds) when the last fan pulse occurred
93
 
static unsigned long last_pulse_at = 0;
 
101
static unsigned long _last_pulse_at = 0;
94
102
 
95
103
// duration (in microseconds) that a segment should be displayed
96
 
static unsigned long segment_step = 0;
 
104
static unsigned long _segment_step = 0;
97
105
 
98
106
// 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 )
 
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;
117
118
 
118
119
//_____________________________________________________________________________
119
120
//                                                                         code
120
121
 
121
 
 
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;
 
122
// perform button events
 
123
void do_button_events()
 
124
{
 
125
        // loop through pending events
 
126
        while( int event = _button.get_event() )
 
127
        {
 
128
                switch( event )
 
129
                {
 
130
                case 1:
 
131
                        // short press
 
132
                        _modes[ _mode ]->press();
 
133
                        break;
 
134
                case 2:
 
135
                        // long press
 
136
                        _modes[ _mode ]->long_press();
 
137
                        break;
 
138
                case 3:
 
139
                        // looooong press (change major mode)
 
140
                        _modes[ _mode ]->deactivate();
 
141
                        if( !_modes[ ++_mode ] ) _mode = 0;
 
142
                        _modes[ _mode ]->activate();
 
143
                        break;
159
144
                }
160
145
        }
161
146
}
162
147
 
163
148
 
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 )
 
149
// draw a display segment
 
150
void draw_next_segment( bool reset )
182
151
{
183
152
        // 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
206
 
        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
 
        }
 
153
#if CLOCK_FORWARD
 
154
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
155
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
156
#else
 
157
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
158
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
159
#endif
 
160
 
 
161
        // reset the text renderer's buffer
 
162
        TextRenderer::reset_buffer();
 
163
 
 
164
        if( reset )
 
165
        {
 
166
                _modes[ _mode ]->draw_reset();
 
167
 
 
168
                // tell the text services we're starting a new frame
 
169
                Text::draw_reset();
 
170
        }
 
171
 
 
172
        // draw
 
173
        _modes[ _mode ]->draw( segment );
 
174
 
 
175
        // TODO: remove this hack
 
176
        Text::post_draw();
 
177
 
 
178
        // draw text rednerer's buffer
 
179
        TextRenderer::output_buffer();
 
180
 
 
181
#if CLOCK_FORWARD
 
182
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
183
#else
 
184
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
185
#endif
251
186
}
252
187
 
253
188
 
254
189
// calculate time constants when a new pulse has occurred
255
 
void calculateSegmentTimes()
 
190
void calculate_segment_times()
256
191
{
257
192
        // check for overflows, and only recalculate times if there isn't
258
193
        // one (if there is, we'll just go with the last pulse's times)
259
 
        if( new_pulse_at > last_pulse_at )
 
194
        if( _new_pulse_at > _last_pulse_at )
260
195
        {
261
196
                // 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;
 
197
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
198
                _segment_step = delta / NUM_SEGMENTS;
 
199
                _segment_step_sub = 0;
 
200
                _segment_step_sub_step = delta % NUM_SEGMENTS;
266
201
        }
267
202
 
268
203
        // now we have dealt with this pulse, save the pulse time and
269
204
        // clear new_pulse_at, ready for the next pulse
270
 
        last_pulse_at = new_pulse_at;
271
 
        new_pulse_at = 0;
 
205
        _last_pulse_at = _new_pulse_at;
 
206
        _new_pulse_at = 0;
272
207
}
273
208
 
274
209
 
275
210
// wait until it is time to draw the next segment or a new pulse has
276
211
// occurred
277
 
void waitTillNextSegment( bool reset )
 
212
void wait_till_end_of_segment( bool reset )
278
213
{
279
214
        static unsigned long end_time = 0;
280
215
 
281
216
        // handle reset
282
217
        if( reset )
283
 
                end_time = last_pulse_at;
 
218
                end_time = _last_pulse_at;
284
219
 
285
220
        // 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;
 
221
        end_time += _segment_step;
 
222
        _segment_step_sub += _segment_step_sub_step;
 
223
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
224
                _segment_step_sub -= NUM_SEGMENTS;
290
225
                end_time++;
291
226
        }
292
227
 
293
228
        // wait
294
 
        while( micros() < end_time && !new_pulse_at );
 
229
        while( micros() < end_time && !_new_pulse_at );
295
230
}
296
231
 
297
232
 
298
 
// ISR to handle the pulses from the fan's tachiometer
299
 
void fanPulseHandler()
 
233
// ISR to handle the pulses from the fan's tachometer
 
234
void fan_pulse_handler()
300
235
{
301
236
        // the fan actually sends two pulses per revolution. These pulses
302
237
        // may not be exactly evenly distributed around the rotation, so
307
242
        if( !ignore )
308
243
        {
309
244
                // set a new pulse time
310
 
                new_pulse_at = micros();
 
245
                _new_pulse_at = micros();
311
246
        }
312
247
}
313
248
 
315
250
// main setup
316
251
void setup()
317
252
{
318
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
319
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
253
        // set up an interrupt handler on pin 2 to notice fan pulses
 
254
        attachInterrupt( 0, fan_pulse_handler, RISING );
320
255
        digitalWrite( 2, HIGH );
321
256
  
322
257
        // set up output pins (4 to 13) for the led array
326
261
        // set up mode-switch button on pin 3
327
262
        pinMode( 3, INPUT );
328
263
        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 );
 
264
        static int event_times[] = { 5, 500, 4000, 0 };
 
265
        _button.set_event_times( event_times );
 
266
 
 
267
        // initialise RTC
 
268
        Time::init();
 
269
 
 
270
        // init text renderer
 
271
        TextRenderer::init();
 
272
 
 
273
        // reset text
 
274
        Text::reset();
 
275
        leds_off();
 
276
 
 
277
        static SwitcherMajorMode switcher;
 
278
        static SettingsMajorMode settings;
 
279
 
 
280
        // add major modes
 
281
        int mode = 0;
 
282
        _modes[ mode++ ] = &switcher;
 
283
        _modes[ mode++ ] = &settings;
 
284
        _modes[ mode ] = 0;
 
285
 
 
286
        // activate the current major mode
 
287
        _modes[ _mode ]->activate();
339
288
}
340
289
 
341
290
 
343
292
void loop()
344
293
{
345
294
        // if there has been a new pulse, we'll be resetting the display
346
 
        bool reset = new_pulse_at? true : false;
 
295
        bool reset = _new_pulse_at? true : false;
 
296
 
 
297
        // update button
 
298
        _button.update();
347
299
 
348
300
        // only do this stuff at the start of a display cycle, to ensure
349
301
        // that no state changes mid-display
350
302
        if( reset )
351
303
        {
352
 
                // check buttons
353
 
                checkButtons();
 
304
                // calculate segment times
 
305
                calculate_segment_times();
354
306
 
355
307
                // keep track of time
356
 
                trackTime();
 
308
                Time::update();
 
309
 
 
310
                // perform button events
 
311
                do_button_events();
357
312
        }
358
313
 
359
314
        // draw this segment
360
 
        drawNextSegment( reset );
361
 
 
362
 
        // do we need to recalculate segment times?
363
 
        if( reset )
364
 
                calculateSegmentTimes();
 
315
        draw_next_segment( reset );
365
316
 
366
317
        // wait till it's time to draw the next segment
367
 
        waitTillNextSegment( reset );
 
318
        wait_till_end_of_segment( reset );
368
319
}