/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 propeller-clock/propeller-clock.pde

  • Committer: edam
  • Date: 2011-11-17 19:17:46 UTC
  • Revision ID: edam@waxworlds.org-20111117191746-2pfwki7br7iep6x8
finished first revision of propeller-clock code (can display clock and test); added Bounce library

Show diffs side-by-side

added added

removed removed

propeller-clock/propeller-clock.pde
1
 
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
1
/*
3
 
 * propeller-clock.ino
 
2
 * propeller-clock.pde
4
3
 *
5
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
4
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
6
5
 *
7
6
 * This file is part of propeller-clock (hereafter referred to as "this
8
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
7
 * program"). See http://ed.am/software/arduino/propeller-clock for more
9
8
 * information.
10
9
 *
11
10
 * This program is free software: you can redistribute it and/or modify
24
23
 
25
24
/******************************************************************************
26
25
 
27
 
Set up:
28
 
 
29
 
 * a PC fan is wired up to a 12V power supply
30
 
 
31
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
32
 
   arduino.
33
 
 
34
 
 * the pins 4 to 13 on the arduino should directly drive an LED (the
35
 
   LED on pin 4 is in the centre of the clock face and the LED on pin
36
 
   13 is at the outside.
37
 
 
38
 
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
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.
41
 
 
42
 
 * a button should be attached to pin 3 that grounds it when pressed.
43
 
 
44
 
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
45
 
 
46
 
Implementation details:
47
 
 
48
 
 * for a schematic, see ../project/propeller-clock.sch.
49
 
 
50
 
 * the timing of the drawing of the clock face is recalculated with
51
 
   every rotation of the propeller.
52
 
    
53
 
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
54
 
   software skips every other one. This means that the clock may
55
 
   appear upside-down if started with the propeller in the wrong
56
 
   position. You will need to experiment to dicsover the position that
57
 
   the propeller must be in when starting the clock.
58
 
    
59
 
Usage instructions:
60
 
 
61
 
 * pressing the button cycles between variations of the current
62
 
   display mode.
63
 
  
64
 
 * pressing and holding the button for a second cycles between display
65
 
   modes (e.g., analogue and digital).
66
 
 
67
 
 * pressing and holding the button for 5 seconds enters "time set"
68
 
   mode. In this mode, the following applies:
69
 
    - the field that is being set flashes
70
 
    - pressing the button increments the field currently being set
71
 
    - pressing and holding the button for a second cycles through the
72
 
      fields that can be set
73
 
    - pressing and holding the button for 5 seconds sets the time and
74
 
      exits "time set" mode
 
26
  For a schematic, see propeller-clock.sch.
 
27
 
 
28
  Set up as follows:
 
29
 
 
30
  - a PC fan is wired up to the 12V supply.
 
31
 
 
32
  - the fan's SENSE (tachiometer) pin is connected to pin 2 on the
 
33
    arduino.
 
34
 
 
35
  - the pins 4 to 13 on the arduino should directly drive an LED (the
 
36
    LED on pin 4 is in the centre of the clock face and the LED on pin
 
37
    13 is at the outside.
 
38
 
 
39
  - if a longer hand (and a larger clock face) is desired, pin 4 can
 
40
    be used to indirectly drive (via a MOSFET) multiple LEDs which
 
41
    turn on and off in unison in the centre of the clock.
 
42
 
 
43
  - a button should be attached to pin 3 that grounds it when pressed.
 
44
 
 
45
  Implementation details:
 
46
 
 
47
  - the timing of the drawing of the clock face is recalculated with
 
48
    every rotation of the propeller (for maximum update speed).
 
49
 
 
50
  - pressing the button cycles between display modes
 
51
 
 
52
  - holding down the button for 2 seconds enters "set time" mode. In
 
53
    this mode, the fan must be held still and the LEDs will indicate
 
54
    what number is being entered for each time digit. Pressing the
 
55
    button increments the current digit. Holding it down moves to the
 
56
    next digit (or leaves "set time" mode when there are no more). In
 
57
    order, the digits (with accepted values) are: hours-tens (0 to 2),
 
58
    hours-ones (0 to 9), minutes-tens (0 to 5), minutes-ones (0 to 9).
75
59
 
76
60
******************************************************************************/
77
61
 
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"
 
62
 
 
63
#include <Bounce.h>
85
64
 
86
65
//_____________________________________________________________________________
87
66
//                                                                         data
88
67
 
 
68
 
89
69
// when non-zero, the time (in microseconds) of a new fan pulse that
90
70
// has just occurred, which means that segment drawing needs to be
91
71
// restarted
92
 
static unsigned long _new_pulse_at = 0;
 
72
static unsigned long new_pulse_at = 0;
93
73
 
94
74
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long _last_pulse_at = 0;
 
75
static unsigned long last_pulse_at = 0;
96
76
 
97
77
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long _segment_step = 0;
 
78
static unsigned long segment_step = 0;
99
79
 
100
80
// remainder after divisor and a tally of the remainders for each segment
101
 
static unsigned long _segment_step_sub_step = 0;
102
 
static unsigned long _segment_step_sub = 0;
103
 
 
104
 
// the button
105
 
static Button _button( 3 );
106
 
 
107
 
// modes
108
 
static int _major_mode = 0;
109
 
static int _minor_mode = 0;
110
 
 
111
 
#define MAIN_MODE_IDX 0
112
 
 
113
 
#define ANALOGUE_CLOCK_IDX 0
114
 
#define DIGITAL_CLOCK_IDX 1
115
 
#define TEST_PATTERN_IDX 2
 
81
static unsigned long segment_step_sub_step = 0;
 
82
static unsigned long segment_step_sub = 0;
 
83
 
 
84
// flag to indicate that the drawing mode should be cycled to the next one
 
85
static bool inc_draw_mode = false;
 
86
 
 
87
// a bounce-managed button
 
88
static Bounce button( 3, 5 );
 
89
 
 
90
// the time
 
91
static int time_hours = 0;
 
92
static int time_minutes = 0;
 
93
static int time_seconds = 0;
 
94
 
 
95
// number of segments in a full display (rotation) is 60 (one per
 
96
// second) times the desired number of sub-divisions of a second
 
97
#define NUM_SECOND_SEGMENTS 5
 
98
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
116
99
 
117
100
//_____________________________________________________________________________
118
101
//                                                                         code
119
102
 
120
103
 
121
 
// activate the current minor mode
122
 
void activate_minor_mode()
 
104
// check for button presses
 
105
void checkButtons()
123
106
{
124
 
        switch( _minor_mode ) {
125
 
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
126
 
        }
 
107
        // update buttons
 
108
        button.update();
 
109
 
 
110
        // notice button presses
 
111
        if( button.risingEdge() )
 
112
                inc_draw_mode = true;
127
113
}
128
114
 
129
 
// perform button events
130
 
void do_button_events()
 
115
 
 
116
// keep track of time
 
117
void trackTime()
131
118
{
132
 
        // loop through pending events
133
 
        while( int event = _button.get_event() )
134
 
        {
135
 
                switch( event )
136
 
                {
137
 
                case 1:
138
 
                        // short press
139
 
                        switch( _major_mode ) {
140
 
                        case MAIN_MODE_IDX:
141
 
                                switch( _minor_mode ) {
142
 
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
143
 
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
144
 
                                }
145
 
                                break;
146
 
                        }
147
 
                        break;
148
 
 
149
 
                case 2:
150
 
                        // long press
151
 
                        switch( _major_mode ) {
152
 
                        case MAIN_MODE_IDX:
153
 
                                if( ++_minor_mode >= 3 )
154
 
                                        _minor_mode = 0;
155
 
                                switch( _minor_mode ) {
156
 
                                case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
157
 
                                }
158
 
                                break;
159
 
                        }
160
 
                        break;
161
 
 
162
 
                case 3:
163
 
                        // looooong press (change major mode)
164
 
                        if( ++_major_mode > 0 )
165
 
                                _major_mode = 0;
166
 
                        switch( _major_mode ) {
167
 
                        case MAIN_MODE_IDX: _minor_mode = 0; break;
168
 
                        }
169
 
                        activate_minor_mode();
170
 
                        break;
 
119
        // previous time and any carried-over milliseconds
 
120
        static unsigned long last_time = millis();
 
121
        static unsigned long carry = 0;
 
122
 
 
123
        // how many milliseonds have elapsed since we last checked?
 
124
        unsigned long next_time = millis();
 
125
        unsigned long delta = next_time - last_time + carry;
 
126
 
 
127
        // update the previous time and carried-over milliseconds
 
128
        last_time = next_time;
 
129
        carry = delta % 1000;
 
130
 
 
131
        // add the seconds that have passed to the time
 
132
        time_seconds += delta / 1000;
 
133
        while( time_seconds >= 60 ) {
 
134
                time_seconds -= 60;
 
135
                time_minutes++;
 
136
                if( time_minutes >= 60 ) {
 
137
                        time_minutes -= 60;
 
138
                        time_hours++;
 
139
                        if( time_hours >= 24 )
 
140
                                time_hours -= 24;
171
141
                }
172
142
        }
173
143
}
174
144
 
175
145
 
 
146
// draw a segment for the test display
 
147
void drawNextSegment_test( bool reset )
 
148
{
 
149
        // keep track of segment
 
150
        static unsigned int segment = 0;
 
151
        if( reset ) segment = 0;
 
152
        segment++;
 
153
 
 
154
        // turn on inside and outside LEDs
 
155
        digitalWrite( 4, HIGH );
 
156
        digitalWrite( 13, HIGH );
 
157
 
 
158
        // display segment number in binary across in the inside LEDs,
 
159
        // with the LED on pin 12 showing the least-significant bit
 
160
        for( int a = 0; a < 8; a++ )
 
161
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
162
}
 
163
 
 
164
 
 
165
// draw a segment for the time display
 
166
void drawNextSegment_time( bool reset )
 
167
{
 
168
        static unsigned int second = 0;
 
169
        static unsigned int segment = 0;
 
170
 
 
171
        // handle display reset
 
172
        if( reset ) {
 
173
                second = 0;
 
174
                segment = 0;
 
175
        }
 
176
 
 
177
        // what needs to be drawn?
 
178
        bool draw_tick = second % 5 == 0;
 
179
        bool draw_second = second == time_seconds;
 
180
        bool draw_minute = second == time_minute;
 
181
        bool draw_hour = second == time_hour;
 
182
 
 
183
        // set the LEDs
 
184
        digitalWrite( 13, HIGH );
 
185
        digitalWrite( 12, draw_tick || draw_minute );
 
186
        for( int a = 10; a <= 11; a++ )
 
187
                digitalWrite( a, draw_minute || draw_second );
 
188
        for( int a = 4; a <= 9; a++ )
 
189
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
 
190
 
 
191
        // inc position
 
192
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
 
193
                segment = 0;
 
194
                second++;
 
195
        }
 
196
}
 
197
 
 
198
 
176
199
// draw a display segment
177
 
void draw_next_segment( bool reset )
 
200
void drawNextSegment( bool reset )
178
201
{
179
 
        // keep track of segment
180
 
#if CLOCK_FORWARD
181
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
182
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
183
 
#else
184
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
185
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
186
 
#endif
187
 
 
188
 
        // draw
189
 
        switch( _major_mode ) {
190
 
        case MAIN_MODE_IDX:
191
 
                switch( _minor_mode ) {
192
 
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
193
 
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
194
 
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
195
 
                }
196
 
                break;
197
 
        }
198
 
 
199
 
#if CLOCK_FORWARD
200
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
201
 
#else
202
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
203
 
#endif
 
202
        static int draw_mode = 0;
 
203
 
 
204
        // handle mode switch requests
 
205
        if( reset && inc_draw_mode ) {
 
206
                inc_draw_mode = false;
 
207
                draw_mode++;
 
208
                if( draw_mode >= 2 )
 
209
                        draw_mode = 0;
 
210
        }
 
211
 
 
212
        // draw the segment
 
213
        switch( draw_mode ) {
 
214
        case 0: drawNextSegment_test( reset ); break;
 
215
        case 1: drawNextSegment_time( reset ); break;
 
216
        }
204
217
}
205
218
 
206
219
 
207
220
// calculate time constants when a new pulse has occurred
208
 
void calculate_segment_times()
 
221
void calculateSegmentTimes()
209
222
{
210
223
        // check for overflows, and only recalculate times if there isn't
211
224
        // one (if there is, we'll just go with the last pulse's times)
212
 
        if( _new_pulse_at > _last_pulse_at )
 
225
        if( new_pulse_at > last_pulse_at )
213
226
        {
214
227
                // new segment stepping times
215
 
                unsigned long delta = _new_pulse_at - _last_pulse_at;
216
 
                _segment_step = delta / NUM_SEGMENTS;
217
 
                _segment_step_sub = 0;
218
 
                _segment_step_sub_step = delta % NUM_SEGMENTS;
 
228
                unsigned long delta = new_pulse_at - last_pulse_at;
 
229
                segment_step = delta / NUM_SEGMENTS;
 
230
                segment_step_sub = 0;
 
231
                segment_step_sub_step = delta % NUM_SEGMENTS;
219
232
        }
220
233
 
221
234
        // now we have dealt with this pulse, save the pulse time and
222
235
        // clear new_pulse_at, ready for the next pulse
223
 
        _last_pulse_at = _new_pulse_at;
224
 
        _new_pulse_at = 0;
 
236
        last_pulse_at = new_pulse_at;
 
237
        new_pulse_at = 0;
225
238
}
226
239
 
227
240
 
228
241
// wait until it is time to draw the next segment or a new pulse has
229
242
// occurred
230
 
void wait_till_end_of_segment( bool reset )
 
243
void waitTillNextSegment( bool reset )
231
244
{
232
245
        static unsigned long end_time = 0;
233
246
 
234
247
        // handle reset
235
248
        if( reset )
236
 
                end_time = _last_pulse_at;
 
249
                end_time = last_pulse_at;
237
250
 
238
251
        // work out the time that this segment should be displayed until
239
 
        end_time += _segment_step;
240
 
        _segment_step_sub += _segment_step_sub_step;
241
 
        if( _segment_step_sub >= NUM_SEGMENTS ) {
242
 
                _segment_step_sub -= NUM_SEGMENTS;
 
252
        end_time += segment_step;
 
253
        segment_step_sub += segment_step_sub_step;
 
254
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
255
                segment_step_sub -= NUM_SEGMENTS;
243
256
                end_time++;
244
257
        }
245
258
 
246
259
        // wait
247
 
        while( micros() < end_time && !_new_pulse_at );
 
260
        while( micros() < end_time && !new_pulse_at );
248
261
}
249
262
 
250
263
 
251
264
// ISR to handle the pulses from the fan's tachiometer
252
 
void fan_pulse_handler()
 
265
void fanPulseHandler()
253
266
{
254
267
        // the fan actually sends two pulses per revolution. These pulses
255
268
        // may not be exactly evenly distributed around the rotation, so
260
273
        if( !ignore )
261
274
        {
262
275
                // set a new pulse time
263
 
                _new_pulse_at = micros();
 
276
                new_pulse_at = micros();
264
277
        }
265
278
}
266
279
 
269
282
void setup()
270
283
{
271
284
        // set up an interrupt handler on pin 2 to nitice fan pulses
272
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
285
        attachInterrupt( 0, fanPulseHandler, RISING );
273
286
        digitalWrite( 2, HIGH );
274
287
  
275
288
        // set up output pins (4 to 13) for the led array
278
291
 
279
292
        // set up mode-switch button on pin 3
280
293
        pinMode( 3, INPUT );
281
 
        digitalWrite( 3, HIGH );
282
 
        static int event_times[] = { 5, 500, 4000, 0 };
283
 
        _button.set_event_times( event_times );
284
 
 
285
 
        // get time from RTC
286
 
        Time::init();
287
 
 
288
 
        // activate the minor mode
289
 
        switch( _major_mode ) {
290
 
        case MAIN_MODE_IDX: activate_minor_mode(); break;
291
 
        }
 
294
 
 
295
        // serial comms
 
296
        Serial.begin( 9600 );
292
297
}
293
298
 
294
299
 
296
301
void loop()
297
302
{
298
303
        // if there has been a new pulse, we'll be resetting the display
299
 
        bool reset = _new_pulse_at? true : false;
300
 
 
301
 
        // update button
302
 
        _button.update();
 
304
        bool reset = new_pulse_at? true : false;
303
305
 
304
306
        // only do this stuff at the start of a display cycle, to ensure
305
307
        // that no state changes mid-display
306
308
        if( reset )
307
309
        {
308
 
                // calculate segment times
309
 
                calculate_segment_times();
 
310
                // check buttons
 
311
                checkButtons();
310
312
 
311
313
                // keep track of time
312
 
                Time::update();
313
 
 
314
 
                // perform button events
315
 
                do_button_events();
 
314
                trackTime();
316
315
        }
317
316
 
318
317
        // draw this segment
319
 
        draw_next_segment( reset );
 
318
        drawNextSegment( reset );
 
319
 
 
320
        // do we need to recalculate segment times?
 
321
        if( reset )
 
322
                calculateSegmentTimes();
320
323
 
321
324
        // wait till it's time to draw the next segment
322
 
        wait_till_end_of_segment( reset );
 
325
        waitTillNextSegment( reset );
323
326
}