/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-25 14:54:33 UTC
  • Revision ID: edam@waxworlds.org-20120225145433-kih8qs45x05cum46
removed Bounce library and updated/fixed new code

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 (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 "button.h"
78
79
#include "config.h"
79
 
#include "button.h"
80
80
#include "time.h"
81
 
#include "Arduino.h"
82
 
#include "analogue_clock.h"
83
 
#include "digital_clock.h"
84
 
#include "test_pattern.h"
 
81
#include "mode_switcher.h"
 
82
#include "drawer.h"
85
83
 
86
84
//_____________________________________________________________________________
87
85
//                                                                         data
88
86
 
 
87
 
89
88
// when non-zero, the time (in microseconds) of a new fan pulse that
90
89
// has just occurred, which means that segment drawing needs to be
91
90
// restarted
92
 
static unsigned long _new_pulse_at = 0;
 
91
static unsigned long new_pulse_at = 0;
93
92
 
94
93
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long _last_pulse_at = 0;
 
94
static unsigned long last_pulse_at = 0;
96
95
 
97
96
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long _segment_step = 0;
 
97
static unsigned long segment_step = 0;
99
98
 
100
99
// 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;
 
100
static unsigned long segment_step_sub_step = 0;
 
101
static unsigned long segment_step_sub = 0;
103
102
 
104
103
// 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
 
104
static Button button( 3 );
 
105
 
 
106
// major mode
 
107
static int major_mode = 0;
 
108
 
 
109
// major modes
 
110
static std::vector< MajorMode * > major_modes;
116
111
 
117
112
//_____________________________________________________________________________
118
113
//                                                                         code
119
114
 
120
115
 
121
 
// activate the current minor mode
122
 
void activate_minor_mode()
123
 
{
124
 
        switch( _minor_mode ) {
125
 
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
126
 
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
127
 
        }
128
 
}
129
 
 
130
 
// perform button events
131
 
void do_button_events()
132
 
{
133
 
        // loop through pending events
134
 
        while( int event = _button.get_event() )
135
 
        {
136
 
                switch( event )
137
 
                {
138
 
                case 1:
139
 
                        // short press
140
 
                        switch( _major_mode ) {
141
 
                        case MAIN_MODE_IDX:
142
 
                                switch( _minor_mode ) {
143
 
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
144
 
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
145
 
                                }
146
 
                                break;
147
 
                        }
148
 
                        break;
149
 
 
150
 
                case 2:
151
 
                        // long press
152
 
                        switch( _major_mode ) {
153
 
                        case MAIN_MODE_IDX:
154
 
                                if( ++_minor_mode >= 3 )
155
 
                                        _minor_mode = 0;
156
 
                                switch( _minor_mode ) {
157
 
                                case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
158
 
                                }
159
 
                                break;
160
 
                        }
161
 
                        break;
162
 
 
163
 
                case 3:
164
 
                        // looooong press (change major mode)
165
 
                        if( ++_major_mode > 0 )
166
 
                                _major_mode = 0;
167
 
                        switch( _major_mode ) {
168
 
                        case MAIN_MODE_IDX: _minor_mode = 0; break;
169
 
                        }
170
 
                        activate_minor_mode();
171
 
                        break;
172
 
                }
 
116
// check for button presses
 
117
void checkButtons()
 
118
{
 
119
        // update buttons
 
120
        int event = button.update();
 
121
 
 
122
        // handle any events
 
123
        switch( event ) {
 
124
        case 1:
 
125
                major_modes[ major_mode ]->short_press();
 
126
                break;
 
127
        case 2:
 
128
                major_modes[ major_mode ]->long_press();
 
129
                break;
 
130
        case 3:
 
131
                if( ++major_mode >= major_modes.size() )
 
132
                        major_mode = 0;
 
133
                major_modes[ major_mode ]->activate();
 
134
                break;
173
135
        }
174
136
}
175
137
 
176
138
 
177
139
// draw a display segment
178
 
void draw_next_segment( bool reset )
 
140
void drawNextSegment( bool reset )
179
141
{
180
142
        // keep track of segment
181
143
#if CLOCK_FORWARD
186
148
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
187
149
#endif
188
150
 
189
 
        // frame reset
190
 
        if( reset ) {
191
 
                switch( _major_mode ) {
192
 
                case MAIN_MODE_IDX:
193
 
                        switch( _minor_mode ) {
194
 
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
195
 
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
196
 
                        }
197
 
                        break;
198
 
                }
199
 
        }
200
 
 
201
151
        // draw
202
 
        switch( _major_mode ) {
203
 
        case MAIN_MODE_IDX:
204
 
                switch( _minor_mode ) {
205
 
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
206
 
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
207
 
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
208
 
                }
209
 
                break;
210
 
        }
 
152
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
 
153
        if( reset ) drawer.draw_reset();
 
154
        drawer.draw( segment );
211
155
 
212
156
#if CLOCK_FORWARD
213
157
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
218
162
 
219
163
 
220
164
// calculate time constants when a new pulse has occurred
221
 
void calculate_segment_times()
 
165
void calculateSegmentTimes()
222
166
{
223
167
        // check for overflows, and only recalculate times if there isn't
224
168
        // one (if there is, we'll just go with the last pulse's times)
225
 
        if( _new_pulse_at > _last_pulse_at )
 
169
        if( new_pulse_at > last_pulse_at )
226
170
        {
227
171
                // new segment stepping times
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;
 
172
                unsigned long delta = new_pulse_at - last_pulse_at;
 
173
                segment_step = delta / NUM_SEGMENTS;
 
174
                segment_step_sub = 0;
 
175
                segment_step_sub_step = delta % NUM_SEGMENTS;
232
176
        }
233
177
 
234
178
        // now we have dealt with this pulse, save the pulse time and
235
179
        // clear new_pulse_at, ready for the next pulse
236
 
        _last_pulse_at = _new_pulse_at;
237
 
        _new_pulse_at = 0;
 
180
        last_pulse_at = new_pulse_at;
 
181
        new_pulse_at = 0;
238
182
}
239
183
 
240
184
 
241
185
// wait until it is time to draw the next segment or a new pulse has
242
186
// occurred
243
 
void wait_till_end_of_segment( bool reset )
 
187
void waitTillNextSegment( bool reset )
244
188
{
245
189
        static unsigned long end_time = 0;
246
190
 
247
191
        // handle reset
248
192
        if( reset )
249
 
                end_time = _last_pulse_at;
 
193
                end_time = last_pulse_at;
250
194
 
251
195
        // work out the time that this segment should be displayed until
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;
 
196
        end_time += segment_step;
 
197
        segment_step_sub += segment_step_sub_step;
 
198
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
199
                segment_step_sub -= NUM_SEGMENTS;
256
200
                end_time++;
257
201
        }
258
202
 
259
203
        // wait
260
 
        while( micros() < end_time && !_new_pulse_at );
 
204
        while( micros() < end_time && !new_pulse_at );
261
205
}
262
206
 
263
207
 
264
208
// ISR to handle the pulses from the fan's tachiometer
265
 
void fan_pulse_handler()
 
209
void fanPulseHandler()
266
210
{
267
211
        // the fan actually sends two pulses per revolution. These pulses
268
212
        // may not be exactly evenly distributed around the rotation, so
273
217
        if( !ignore )
274
218
        {
275
219
                // set a new pulse time
276
 
                _new_pulse_at = micros();
 
220
                new_pulse_at = micros();
277
221
        }
278
222
}
279
223
 
282
226
void setup()
283
227
{
284
228
        // set up an interrupt handler on pin 2 to nitice fan pulses
285
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
229
        attachInterrupt( 0, fanPulseHandler, RISING );
286
230
        digitalWrite( 2, HIGH );
287
231
  
288
232
        // set up output pins (4 to 13) for the led array
292
236
        // set up mode-switch button on pin 3
293
237
        pinMode( 3, INPUT );
294
238
        digitalWrite( 3, HIGH );
295
 
        static int event_times[] = { 5, 500, 4000, 0 };
296
 
        _button.set_event_times( event_times );
297
 
 
298
 
        // initialise RTC
299
 
        Time::init();
300
 
 
301
 
        // activate the minor mode
302
 
        switch( _major_mode ) {
303
 
        case MAIN_MODE_IDX: activate_minor_mode(); break;
304
 
        }
 
239
        button.add_event_at( 5, 1 );
 
240
        button.add_event_at( 1000, 2 );
 
241
        button.add_event_at( 4000, 3 );
 
242
 
 
243
        // serial comms
 
244
        Serial.begin( 9600 );
 
245
 
 
246
        // set up major modes
 
247
        static ModeSwitcher mode_switcher;
 
248
        major_modes.push_back( &mode_switcher );
 
249
        major_modes[ 0 ]->activate();
305
250
}
306
251
 
307
252
 
309
254
void loop()
310
255
{
311
256
        // if there has been a new pulse, we'll be resetting the display
312
 
        bool reset = _new_pulse_at? true : false;
313
 
 
314
 
        // update button
315
 
        _button.update();
 
257
        bool reset = new_pulse_at? true : false;
316
258
 
317
259
        // only do this stuff at the start of a display cycle, to ensure
318
260
        // that no state changes mid-display
319
261
        if( reset )
320
262
        {
321
 
                // calculate segment times
322
 
                calculate_segment_times();
 
263
                // check buttons
 
264
                checkButtons();
323
265
 
324
266
                // keep track of time
325
 
                Time::update();
326
 
 
327
 
                // perform button events
328
 
                do_button_events();
 
267
                Time &time = Time::get_instance();
 
268
                time.update();
329
269
        }
330
270
 
331
271
        // draw this segment
332
 
        draw_next_segment( reset );
 
272
        drawNextSegment( reset );
 
273
 
 
274
        // do we need to recalculate segment times?
 
275
        if( reset )
 
276
                calculateSegmentTimes();
333
277
 
334
278
        // wait till it's time to draw the next segment
335
 
        wait_till_end_of_segment( reset );
 
279
        waitTillNextSegment( reset );
336
280
}