/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: Tim Marston
  • Date: 2012-03-10 12:56:55 UTC
  • Revision ID: tim@ed.am-20120310125655-z72qh4bqou2byi2r
added frame reset code and inited minor mode flavours on mode activation

Show diffs side-by-side

added added

removed removed

src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
1
2
/*
2
 
 * propeller-clock.pde
 
3
 * propeller-clock.ino
3
4
 *
4
 
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
 
5
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
6
 *
6
7
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/software/arduino/propeller-clock for more
 
8
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
8
9
 * information.
9
10
 *
10
11
 * This program is free software: you can redistribute it and/or modify
21
22
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23
 */
23
24
 
 
25
/******************************************************************************
 
26
 
 
27
Set up:
 
28
 
 
29
 * a PC fan is wired up to a 12V power supply
 
30
 
 
31
 * the fan's SENSE (tachometer) 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 and 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 analogue 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 tachometer 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 discover 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
 
75
 
 
76
******************************************************************************/
 
77
 
 
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"
 
85
 
24
86
//_____________________________________________________________________________
25
87
//                                                                         data
26
88
 
27
 
 
28
89
// when non-zero, the time (in microseconds) of a new fan pulse that
29
90
// has just occurred, which means that segment drawing needs to be
30
91
// restarted
31
 
static unsigned long new_pulse_at = 0;
 
92
static unsigned long _new_pulse_at = 0;
32
93
 
33
94
// the time (in microseconds) when the last fan pulse occurred
34
 
static unsigned long last_pulse_at = 0;
 
95
static unsigned long _last_pulse_at = 0;
35
96
 
36
97
// duration (in microseconds) that a segment should be displayed
37
 
static unsigned long segment_step = 0;
 
98
static unsigned long _segment_step = 0;
38
99
 
39
100
// remainder after divisor and a tally of the remainders for each segment
40
 
static unsigned long segment_step_sub_step = 0;
41
 
static unsigned long segment_step_sub = 0;
42
 
 
43
 
// number of segments in a full display (rotation) is 60 (one per
44
 
// second) times the desired number of sub-divisions of a second
45
 
#define NUM_SEGMENTS ( 60 * 5 )
46
 
 
 
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
47
116
 
48
117
//_____________________________________________________________________________
49
118
//                                                                         code
50
119
 
51
120
 
52
 
// ISR to handle the pulses from the fan's tachiometer
53
 
void fanPulseHandler()
54
 
{
55
 
        // the fan actually sends two pulses per revolution. These pulses
56
 
        // may not be exactly evenly distributed around the rotation, so
57
 
        // we can't recalculate times on every pulse. Instead, we ignore
58
 
        // every other pulse so timings are based on a complete rotation.
59
 
        static bool ignore = true;
60
 
        ignore = !ignore;
61
 
        if( !ignore )
 
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() )
62
135
        {
63
 
                // set a new pulse time
64
 
                new_pulse_at = micros();
 
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
                }
65
173
        }
66
174
}
67
175
 
68
176
 
69
 
// draw a particular segment
70
 
void drawNextSegment( bool reset )
 
177
// draw a display segment
 
178
void draw_next_segment( bool reset )
71
179
{
72
 
        static unsigned int segment = 0;
73
 
        if( reset ) segment = 0;
74
 
        segment++;
75
 
 
76
 
        for( int a = 0; a < 10; a++ )
77
 
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
180
        // keep track of segment
 
181
#if CLOCK_FORWARD
 
182
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
183
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
184
#else
 
185
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
186
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
187
#endif
 
188
 
 
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
        // 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
        }
 
211
 
 
212
#if CLOCK_FORWARD
 
213
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
214
#else
 
215
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
216
#endif
78
217
}
79
218
 
80
219
 
81
220
// calculate time constants when a new pulse has occurred
82
 
void calculateSegmentTimes()
 
221
void calculate_segment_times()
83
222
{
84
223
        // check for overflows, and only recalculate times if there isn't
85
224
        // one (if there is, we'll just go with the last pulse's times)
86
 
        if( new_pulse_at > last_pulse_at )
 
225
        if( _new_pulse_at > _last_pulse_at )
87
226
        {
88
227
                // new segment stepping times
89
 
                unsigned long delta = new_pulse_at - last_pulse_at;
90
 
                segment_step = delta / NUM_SEGMENTS;
91
 
                segment_step_sub = 0;
92
 
                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;
93
232
        }
94
233
 
95
234
        // now we have dealt with this pulse, save the pulse time and
96
235
        // clear new_pulse_at, ready for the next pulse
97
 
        last_pulse_at = new_pulse_at;
98
 
        new_pulse_at = 0;
 
236
        _last_pulse_at = _new_pulse_at;
 
237
        _new_pulse_at = 0;
99
238
}
100
239
 
101
240
 
102
241
// wait until it is time to draw the next segment or a new pulse has
103
242
// occurred
104
 
void waitTillNextSegment( bool reset )
 
243
void wait_till_end_of_segment( bool reset )
105
244
{
106
245
        static unsigned long end_time = 0;
107
246
 
108
247
        // handle reset
109
248
        if( reset )
110
 
                end_time = last_pulse_at;
 
249
                end_time = _last_pulse_at;
111
250
 
112
251
        // work out the time that this segment should be displayed until
113
 
        end_time += segment_step;
114
 
        semgment_step_sub += semgment_step_sub_step;
115
 
        if( semgment_step_sub >= NUM_SEGMENTS ) {
116
 
                semgment_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;
117
256
                end_time++;
118
257
        }
119
258
 
120
259
        // wait
121
 
        while( micros() < end_time && !new_pulse_at );
 
260
        while( micros() < end_time && !_new_pulse_at );
 
261
}
 
262
 
 
263
 
 
264
// ISR to handle the pulses from the fan's tachiometer
 
265
void fan_pulse_handler()
 
266
{
 
267
        // the fan actually sends two pulses per revolution. These pulses
 
268
        // may not be exactly evenly distributed around the rotation, so
 
269
        // we can't recalculate times on every pulse. Instead, we ignore
 
270
        // every other pulse so timings are based on a complete rotation.
 
271
        static bool ignore = true;
 
272
        ignore = !ignore;
 
273
        if( !ignore )
 
274
        {
 
275
                // set a new pulse time
 
276
                _new_pulse_at = micros();
 
277
        }
122
278
}
123
279
 
124
280
 
126
282
void setup()
127
283
{
128
284
        // set up an interrupt handler on pin 2 to nitice fan pulses
129
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
285
        attachInterrupt( 0, fan_pulse_handler, RISING );
130
286
        digitalWrite( 2, HIGH );
131
287
  
132
288
        // set up output pins (4 to 13) for the led array
133
289
        for( int a = 4; a < 14; a++ )
134
290
                pinMode( a, OUTPUT );
135
291
 
136
 
        // serial comms
137
 
        Serial.begin( 9600 );
 
292
        // set up mode-switch button on pin 3
 
293
        pinMode( 3, INPUT );
 
294
        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
        }
138
305
}
139
306
 
140
307
 
142
309
void loop()
143
310
{
144
311
        // if there has been a new pulse, we'll be resetting the display
145
 
        bool reset = new_pulse_at? true : false;
 
312
        bool reset = _new_pulse_at? true : false;
 
313
 
 
314
        // update button
 
315
        _button.update();
 
316
 
 
317
        // only do this stuff at the start of a display cycle, to ensure
 
318
        // that no state changes mid-display
 
319
        if( reset )
 
320
        {
 
321
                // calculate segment times
 
322
                calculate_segment_times();
 
323
 
 
324
                // keep track of time
 
325
                Time::update();
 
326
 
 
327
                // perform button events
 
328
                do_button_events();
 
329
        }
146
330
 
147
331
        // draw this segment
148
 
        drawNextSegment( reset );
149
 
 
150
 
        // do we need to recalculate segment times?
151
 
        if( reset )
152
 
                calculateSegmentTimes();
 
332
        draw_next_segment( reset );
153
333
 
154
334
        // wait till it's time to draw the next segment
155
 
        waitTillNextSegment( reset );
 
335
        wait_till_end_of_segment( reset );
156
336
}