/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-02-23 00:26:32 UTC
  • Revision ID: edam@waxworlds.org-20120223002632-kkwrdwijfmv45f0j
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)

Show diffs side-by-side

added added

removed removed

src/propeller-clock.ino
28
28
 
29
29
 * a PC fan is wired up to a 12V power supply
30
30
 
31
 
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
32
 
   Arduino.
 
31
 * the fan's SENSE (tachiometer) 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 and off in unison in the centre of the clock.
 
40
   LEDs that turn on anf 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 analogue pins 4 and 5.
 
44
 * A DS1307 remote clock is connected via I2C on analog 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 tachometer pulses per revolution, so the
 
53
 * a PC fan actually sends 2 tachiometer 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 discover the position that
 
56
   position. You will need to experiment to dicsover 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
 
#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"
 
78
 
 
79
#include <Bounce.h>
 
80
#include <DS1307.h>
 
81
#include <Wire.h>
91
82
 
92
83
//_____________________________________________________________________________
93
84
//                                                                         data
94
85
 
 
86
 
95
87
// when non-zero, the time (in microseconds) of a new fan pulse that
96
88
// has just occurred, which means that segment drawing needs to be
97
89
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
90
static unsigned long new_pulse_at = 0;
99
91
 
100
92
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
93
static unsigned long last_pulse_at = 0;
102
94
 
103
95
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
96
static unsigned long segment_step = 0;
105
97
 
106
98
// 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;
 
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
118
120
 
119
121
//_____________________________________________________________________________
120
122
//                                                                         code
121
123
 
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;
 
124
 
 
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;
144
162
                }
145
163
        }
146
164
}
147
165
 
148
166
 
 
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
 
149
219
// draw a display segment
150
 
void draw_next_segment( bool reset )
 
220
void drawNextSegment( bool reset )
151
221
{
 
222
        static int draw_mode = 0;
 
223
 
152
224
        // keep track of segment
153
225
#if CLOCK_FORWARD
154
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
155
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
226
        static int segment = 0;
 
227
        if( reset ) segment = 0;
156
228
#else
157
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
158
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
229
        static int segment = NUM_SEGMENTS - 1;
 
230
        if( reset ) segment = NUM_SEGMENTS - 1;
159
231
#endif
160
232
 
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();
 
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
        }
180
246
 
181
247
#if CLOCK_FORWARD
182
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
248
        segment++;
183
249
#else
184
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
250
        segment--;
185
251
#endif
186
252
}
187
253
 
188
254
 
189
255
// calculate time constants when a new pulse has occurred
190
 
void calculate_segment_times()
 
256
void calculateSegmentTimes()
191
257
{
192
258
        // check for overflows, and only recalculate times if there isn't
193
259
        // one (if there is, we'll just go with the last pulse's times)
194
 
        if( _new_pulse_at > _last_pulse_at )
 
260
        if( new_pulse_at > last_pulse_at )
195
261
        {
196
262
                // 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;
 
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;
201
267
        }
202
268
 
203
269
        // now we have dealt with this pulse, save the pulse time and
204
270
        // clear new_pulse_at, ready for the next pulse
205
 
        _last_pulse_at = _new_pulse_at;
206
 
        _new_pulse_at = 0;
 
271
        last_pulse_at = new_pulse_at;
 
272
        new_pulse_at = 0;
207
273
}
208
274
 
209
275
 
210
276
// wait until it is time to draw the next segment or a new pulse has
211
277
// occurred
212
 
void wait_till_end_of_segment( bool reset )
 
278
void waitTillNextSegment( bool reset )
213
279
{
214
280
        static unsigned long end_time = 0;
215
281
 
216
282
        // handle reset
217
283
        if( reset )
218
 
                end_time = _last_pulse_at;
 
284
                end_time = last_pulse_at;
219
285
 
220
286
        // 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;
 
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;
225
291
                end_time++;
226
292
        }
227
293
 
228
294
        // wait
229
 
        while( micros() < end_time && !_new_pulse_at );
 
295
        while( micros() < end_time && !new_pulse_at );
230
296
}
231
297
 
232
298
 
233
 
// ISR to handle the pulses from the fan's tachometer
234
 
void fan_pulse_handler()
 
299
// ISR to handle the pulses from the fan's tachiometer
 
300
void fanPulseHandler()
235
301
{
236
302
        // the fan actually sends two pulses per revolution. These pulses
237
303
        // may not be exactly evenly distributed around the rotation, so
242
308
        if( !ignore )
243
309
        {
244
310
                // set a new pulse time
245
 
                _new_pulse_at = micros();
 
311
                new_pulse_at = micros();
246
312
        }
247
313
}
248
314
 
250
316
// main setup
251
317
void setup()
252
318
{
253
 
        // set up an interrupt handler on pin 2 to notice fan pulses
254
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
319
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
320
        attachInterrupt( 0, fanPulseHandler, RISING );
255
321
        digitalWrite( 2, HIGH );
256
322
  
257
323
        // set up output pins (4 to 13) for the led array
261
327
        // set up mode-switch button on pin 3
262
328
        pinMode( 3, INPUT );
263
329
        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::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();
 
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 );
288
340
}
289
341
 
290
342
 
292
344
void loop()
293
345
{
294
346
        // 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();
 
347
        bool reset = new_pulse_at? true : false;
299
348
 
300
349
        // only do this stuff at the start of a display cycle, to ensure
301
350
        // that no state changes mid-display
302
351
        if( reset )
303
352
        {
304
 
                // calculate segment times
305
 
                calculate_segment_times();
 
353
                // check buttons
 
354
                checkButtons();
306
355
 
307
356
                // keep track of time
308
 
                Time::update();
309
 
 
310
 
                // perform button events
311
 
                do_button_events();
 
357
                trackTime();
312
358
        }
313
359
 
314
360
        // draw this segment
315
 
        draw_next_segment( reset );
 
361
        drawNextSegment( reset );
 
362
 
 
363
        // do we need to recalculate segment times?
 
364
        if( reset )
 
365
                calculateSegmentTimes();
316
366
 
317
367
        // wait till it's time to draw the next segment
318
 
        wait_till_end_of_segment( reset );
 
368
        waitTillNextSegment( reset );
319
369
}