/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-01 14:05:28 UTC
  • Revision ID: edam@waxworlds.org-20120101140528-ldqldo67nil1xf1s
added arduino.mk to the project

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
   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.
 
38
   used to indirectly drive (via a MOSFET) multiple LEDs which turn on
 
39
   and 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.
45
 
 
46
43
Implementation details:
47
44
 
48
 
 * for a schematic, see ../project/propeller-clock.sch.
 
45
 * for a schematic, see project/propeller-clock.sch.
49
46
 
50
47
 * the timing of the drawing of the clock face is recalculated with
51
48
   every rotation of the propeller.
52
49
    
53
 
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
 
50
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
54
51
   software skips every other one. This means that the clock may
55
52
   appear upside-down if started with the propeller in the wrong
56
 
   position. You will need to experiment to discover the position that
 
53
   position. You will need to experiment to dicsover the position that
57
54
   the propeller must be in when starting the clock.
58
55
    
59
56
Usage instructions:
70
67
    - pressing the button increments the field currently being set
71
68
    - pressing and holding the button for a second cycles through the
72
69
      fields that can be set
73
 
    - pressing and holding the button for 5 seconds sets the time and
74
 
      exits "time set" mode
 
70
    - press and holding the button for 5 seconds to finish
75
71
 
76
72
******************************************************************************/
77
73
 
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"
 
74
 
 
75
#include <Bounce.h>
91
76
 
92
77
//_____________________________________________________________________________
93
78
//                                                                         data
94
79
 
 
80
 
95
81
// when non-zero, the time (in microseconds) of a new fan pulse that
96
82
// has just occurred, which means that segment drawing needs to be
97
83
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
84
static unsigned long new_pulse_at = 0;
99
85
 
100
86
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
87
static unsigned long last_pulse_at = 0;
102
88
 
103
89
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
90
static unsigned long segment_step = 0;
105
91
 
106
92
// 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;
 
93
static unsigned long segment_step_sub_step = 0;
 
94
static unsigned long segment_step_sub = 0;
 
95
 
 
96
// flag to indicate that the drawing mode should be cycled to the next one
 
97
static bool inc_draw_mode = false;
 
98
 
 
99
// a bounce-managed button
 
100
static Bounce button( 3, 5 );
 
101
 
 
102
// the time
 
103
static int time_hours = 0;
 
104
static int time_minutes = 0;
 
105
static int time_seconds = 0;
 
106
 
 
107
// number of segments in a full display (rotation) is 60 (one per
 
108
// second) times the desired number of sub-divisions of a second
 
109
#define NUM_SECOND_SEGMENTS 5
 
110
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
118
111
 
119
112
//_____________________________________________________________________________
120
113
//                                                                         code
121
114
 
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;
 
115
 
 
116
// check for button presses
 
117
void checkButtons()
 
118
{
 
119
        // update buttons
 
120
        button.update();
 
121
 
 
122
        // notice button presses
 
123
        if( button.risingEdge() )
 
124
                inc_draw_mode = true;
 
125
}
 
126
 
 
127
 
 
128
// keep track of time
 
129
void trackTime()
 
130
{
 
131
        // previous time and any carried-over milliseconds
 
132
        static unsigned long last_time = millis();
 
133
        static unsigned long carry = 0;
 
134
 
 
135
        // how many milliseonds have elapsed since we last checked?
 
136
        unsigned long next_time = millis();
 
137
        unsigned long delta = next_time - last_time + carry;
 
138
 
 
139
        // update the previous time and carried-over milliseconds
 
140
        last_time = next_time;
 
141
        carry = delta % 1000;
 
142
 
 
143
        // add the seconds that have passed to the time
 
144
        time_seconds += delta / 1000;
 
145
        while( time_seconds >= 60 ) {
 
146
                time_seconds -= 60;
 
147
                time_minutes++;
 
148
                if( time_minutes >= 60 ) {
 
149
                        time_minutes -= 60;
 
150
                        time_hours++;
 
151
                        if( time_hours >= 24 )
 
152
                                time_hours -= 24;
144
153
                }
145
154
        }
146
155
}
147
156
 
148
157
 
 
158
// draw a segment for the test display
 
159
void drawNextSegment_test( bool reset )
 
160
{
 
161
        // keep track of segment
 
162
        static unsigned int segment = 0;
 
163
        if( reset ) segment = 0;
 
164
        segment++;
 
165
 
 
166
        // turn on inside and outside LEDs
 
167
        digitalWrite( 4, HIGH );
 
168
        digitalWrite( 13, HIGH );
 
169
 
 
170
        // display segment number in binary across in the inside LEDs,
 
171
        // with the LED on pin 12 showing the least-significant bit
 
172
        for( int a = 0; a < 8; a++ )
 
173
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
174
}
 
175
 
 
176
 
 
177
// draw a segment for the time display
 
178
void drawNextSegment_time( bool reset )
 
179
{
 
180
        static unsigned int second = 0;
 
181
        static unsigned int segment = 0;
 
182
 
 
183
        // handle display reset
 
184
        if( reset ) {
 
185
                second = 0;
 
186
                segment = 0;
 
187
        }
 
188
 
 
189
        // what needs to be drawn?
 
190
        bool draw_tick = !segment && second % 5 == 0;
 
191
        bool draw_second = !segment && second == time_seconds;
 
192
        bool draw_minute = !segment && second == time_minutes;
 
193
        bool draw_hour = !segment && second == time_hours;
 
194
 
 
195
        // set the LEDs
 
196
        digitalWrite( 13, HIGH );
 
197
        digitalWrite( 12, draw_tick || draw_minute );
 
198
        for( int a = 10; a <= 11; a++ )
 
199
                digitalWrite( a, draw_minute || draw_second );
 
200
        for( int a = 4; a <= 9; a++ )
 
201
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
 
202
 
 
203
        // inc position
 
204
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
 
205
                segment = 0;
 
206
                second++;
 
207
        }
 
208
}
 
209
 
 
210
 
149
211
// draw a display segment
150
 
void draw_next_segment( bool reset )
 
212
void drawNextSegment( bool reset )
151
213
{
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
 
214
        static int draw_mode = 0;
 
215
 
 
216
        // handle mode switch requests
 
217
        if( reset && inc_draw_mode ) {
 
218
                inc_draw_mode = false;
 
219
                draw_mode++;
 
220
                if( draw_mode >= 2 )
 
221
                        draw_mode = 0;
 
222
        }
 
223
 
 
224
        // draw the segment
 
225
        switch( draw_mode ) {
 
226
        case 0: drawNextSegment_test( reset ); break;
 
227
        case 1: drawNextSegment_time( reset ); break;
 
228
        }
186
229
}
187
230
 
188
231
 
189
232
// calculate time constants when a new pulse has occurred
190
 
void calculate_segment_times()
 
233
void calculateSegmentTimes()
191
234
{
192
235
        // check for overflows, and only recalculate times if there isn't
193
236
        // one (if there is, we'll just go with the last pulse's times)
194
 
        if( _new_pulse_at > _last_pulse_at )
 
237
        if( new_pulse_at > last_pulse_at )
195
238
        {
196
239
                // 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;
 
240
                unsigned long delta = new_pulse_at - last_pulse_at;
 
241
                segment_step = delta / NUM_SEGMENTS;
 
242
                segment_step_sub = 0;
 
243
                segment_step_sub_step = delta % NUM_SEGMENTS;
201
244
        }
202
245
 
203
246
        // now we have dealt with this pulse, save the pulse time and
204
247
        // clear new_pulse_at, ready for the next pulse
205
 
        _last_pulse_at = _new_pulse_at;
206
 
        _new_pulse_at = 0;
 
248
        last_pulse_at = new_pulse_at;
 
249
        new_pulse_at = 0;
207
250
}
208
251
 
209
252
 
210
253
// wait until it is time to draw the next segment or a new pulse has
211
254
// occurred
212
 
void wait_till_end_of_segment( bool reset )
 
255
void waitTillNextSegment( bool reset )
213
256
{
214
257
        static unsigned long end_time = 0;
215
258
 
216
259
        // handle reset
217
260
        if( reset )
218
 
                end_time = _last_pulse_at;
 
261
                end_time = last_pulse_at;
219
262
 
220
263
        // 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;
 
264
        end_time += segment_step;
 
265
        segment_step_sub += segment_step_sub_step;
 
266
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
267
                segment_step_sub -= NUM_SEGMENTS;
225
268
                end_time++;
226
269
        }
227
270
 
228
271
        // wait
229
 
        while( micros() < end_time && !_new_pulse_at );
 
272
        while( micros() < end_time && !new_pulse_at );
230
273
}
231
274
 
232
275
 
233
 
// ISR to handle the pulses from the fan's tachometer
234
 
void fan_pulse_handler()
 
276
// ISR to handle the pulses from the fan's tachiometer
 
277
void fanPulseHandler()
235
278
{
236
279
        // the fan actually sends two pulses per revolution. These pulses
237
280
        // may not be exactly evenly distributed around the rotation, so
242
285
        if( !ignore )
243
286
        {
244
287
                // set a new pulse time
245
 
                _new_pulse_at = micros();
 
288
                new_pulse_at = micros();
246
289
        }
247
290
}
248
291
 
250
293
// main setup
251
294
void setup()
252
295
{
253
 
        // set up an interrupt handler on pin 2 to notice fan pulses
254
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
296
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
297
        attachInterrupt( 0, fanPulseHandler, RISING );
255
298
        digitalWrite( 2, HIGH );
256
299
  
257
300
        // set up output pins (4 to 13) for the led array
260
303
 
261
304
        // set up mode-switch button on pin 3
262
305
        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();
 
306
 
 
307
        // serial comms
 
308
        Serial.begin( 9600 );
288
309
}
289
310
 
290
311
 
292
313
void loop()
293
314
{
294
315
        // 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();
 
316
        bool reset = new_pulse_at? true : false;
299
317
 
300
318
        // only do this stuff at the start of a display cycle, to ensure
301
319
        // that no state changes mid-display
302
320
        if( reset )
303
321
        {
304
 
                // calculate segment times
305
 
                calculate_segment_times();
 
322
                // check buttons
 
323
                checkButtons();
306
324
 
307
325
                // keep track of time
308
 
                Time::update();
309
 
 
310
 
                // perform button events
311
 
                do_button_events();
 
326
                trackTime();
312
327
        }
313
328
 
314
329
        // draw this segment
315
 
        draw_next_segment( reset );
 
330
        drawNextSegment( reset );
 
331
 
 
332
        // do we need to recalculate segment times?
 
333
        if( reset )
 
334
                calculateSegmentTimes();
316
335
 
317
336
        // wait till it's time to draw the next segment
318
 
        wait_till_end_of_segment( reset );
 
337
        waitTillNextSegment( reset );
319
338
}