/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.ino

  • Committer: edam
  • Date: 2012-01-14 17:31:00 UTC
  • Revision ID: edam@waxworlds.org-20120114173100-6gt6jte0j40cchj8
initialise from real-time clock; updated Makefile

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
1
 
/* -*- mode: c++; compile-command: "make"; -*- */
2
1
/*
3
2
 * propeller-clock.ino
4
3
 *
28
27
 
29
28
 * a PC fan is wired up to a 12V power supply
30
29
 
31
 
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
32
 
   Arduino.
 
30
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
 
31
   arduino.
33
32
 
34
 
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
 
33
 * the pins 4 to 13 on the arduino should directly drive an LED (the
35
34
   LED on pin 4 is in the centre of the clock face and the LED on pin
36
35
   13 is at the outside.
37
36
 
38
37
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
39
38
   used to indirectly drive a transistor which in turn drives several
40
 
   LEDs that turn on and off in unison in the centre of the clock.
 
39
   LEDs that turn on anf off in unison in the centre of the clock.
41
40
 
42
41
 * a button should be attached to pin 3 that grounds it when pressed.
43
42
 
44
 
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
 
43
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
45
44
 
46
45
Implementation details:
47
46
 
50
49
 * the timing of the drawing of the clock face is recalculated with
51
50
   every rotation of the propeller.
52
51
    
53
 
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
 
52
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
54
53
   software skips every other one. This means that the clock may
55
54
   appear upside-down if started with the propeller in the wrong
56
 
   position. You will need to experiment to discover the position that
 
55
   position. You will need to experiment to dicsover the position that
57
56
   the propeller must be in when starting the clock.
58
57
    
59
58
Usage instructions:
75
74
 
76
75
******************************************************************************/
77
76
 
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"
 
77
 
 
78
#include <Bounce.h>
 
79
#include <DS1307.h>
 
80
#include <Wire.h>
91
81
 
92
82
//_____________________________________________________________________________
93
83
//                                                                         data
94
84
 
 
85
 
95
86
// when non-zero, the time (in microseconds) of a new fan pulse that
96
87
// has just occurred, which means that segment drawing needs to be
97
88
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
89
static unsigned long new_pulse_at = 0;
99
90
 
100
91
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
92
static unsigned long last_pulse_at = 0;
102
93
 
103
94
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
95
static unsigned long segment_step = 0;
105
96
 
106
97
// remainder after divisor and a tally of the remainders for each segment
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;
 
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 )
118
116
 
119
117
//_____________________________________________________________________________
120
118
//                                                                         code
121
119
 
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;
 
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;
144
158
                }
145
159
        }
146
160
}
147
161
 
148
162
 
 
163
// draw a segment for the test display
 
164
void drawNextSegment_test( bool reset )
 
165
{
 
166
        // 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
 
149
216
// draw a display segment
150
 
void draw_next_segment( bool reset )
 
217
void drawNextSegment( bool reset )
151
218
{
152
 
        // keep track of segment
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
 
        // draw text
176
 
        Text::draw( segment );
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
 
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
        }
186
234
}
187
235
 
188
236
 
189
237
// calculate time constants when a new pulse has occurred
190
 
void calculate_segment_times()
 
238
void calculateSegmentTimes()
191
239
{
192
240
        // check for overflows, and only recalculate times if there isn't
193
241
        // one (if there is, we'll just go with the last pulse's times)
194
 
        if( _new_pulse_at > _last_pulse_at )
 
242
        if( new_pulse_at > last_pulse_at )
195
243
        {
196
244
                // new segment stepping times
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;
 
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;
201
249
        }
202
250
 
203
251
        // now we have dealt with this pulse, save the pulse time and
204
252
        // clear new_pulse_at, ready for the next pulse
205
 
        _last_pulse_at = _new_pulse_at;
206
 
        _new_pulse_at = 0;
 
253
        last_pulse_at = new_pulse_at;
 
254
        new_pulse_at = 0;
207
255
}
208
256
 
209
257
 
210
258
// wait until it is time to draw the next segment or a new pulse has
211
259
// occurred
212
 
void wait_till_end_of_segment( bool reset )
 
260
void waitTillNextSegment( bool reset )
213
261
{
214
262
        static unsigned long end_time = 0;
215
263
 
216
264
        // handle reset
217
265
        if( reset )
218
 
                end_time = _last_pulse_at;
 
266
                end_time = last_pulse_at;
219
267
 
220
268
        // work out the time that this segment should be displayed until
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;
 
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;
225
273
                end_time++;
226
274
        }
227
275
 
228
276
        // wait
229
 
        while( micros() < end_time && !_new_pulse_at );
 
277
        while( micros() < end_time && !new_pulse_at );
230
278
}
231
279
 
232
280
 
233
 
// ISR to handle the pulses from the fan's tachometer
234
 
void fan_pulse_handler()
 
281
// ISR to handle the pulses from the fan's tachiometer
 
282
void fanPulseHandler()
235
283
{
236
284
        // the fan actually sends two pulses per revolution. These pulses
237
285
        // may not be exactly evenly distributed around the rotation, so
242
290
        if( !ignore )
243
291
        {
244
292
                // set a new pulse time
245
 
                _new_pulse_at = micros();
 
293
                new_pulse_at = micros();
246
294
        }
247
295
}
248
296
 
250
298
// main setup
251
299
void setup()
252
300
{
253
 
        // set up an interrupt handler on pin 2 to notice fan pulses
254
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
301
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
302
        attachInterrupt( 0, fanPulseHandler, RISING );
255
303
        digitalWrite( 2, HIGH );
256
304
  
257
305
        // set up output pins (4 to 13) for the led array
260
308
 
261
309
        // set up mode-switch button on pin 3
262
310
        pinMode( 3, INPUT );
263
 
        digitalWrite( 3, HIGH );
264
 
        static int event_times[] = { 5, 500, 4000, 0 };
265
 
        _button.set_event_times( event_times );
266
 
 
267
 
        // initialise RTC
268
 
//      Time::load_time();
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( _button );
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();
 
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 );
288
321
}
289
322
 
290
323
 
292
325
void loop()
293
326
{
294
327
        // if there has been a new pulse, we'll be resetting the display
295
 
        bool reset = _new_pulse_at? true : false;
296
 
 
297
 
        // update button
298
 
        _button.update();
 
328
        bool reset = new_pulse_at? true : false;
299
329
 
300
330
        // only do this stuff at the start of a display cycle, to ensure
301
331
        // that no state changes mid-display
302
332
        if( reset )
303
333
        {
304
 
                // calculate segment times
305
 
                calculate_segment_times();
 
334
                // check buttons
 
335
                checkButtons();
306
336
 
307
337
                // keep track of time
308
 
                Time::update();
309
 
 
310
 
                // perform button events
311
 
                do_button_events();
 
338
                trackTime();
312
339
        }
313
340
 
314
341
        // draw this segment
315
 
        draw_next_segment( reset );
 
342
        drawNextSegment( reset );
 
343
 
 
344
        // do we need to recalculate segment times?
 
345
        if( reset )
 
346
                calculateSegmentTimes();
316
347
 
317
348
        // wait till it's time to draw the next segment
318
 
        wait_till_end_of_segment( reset );
 
349
        waitTillNextSegment( reset );
319
350
}