/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 01:31:17 UTC
  • Revision ID: tim@ed.am-20120225013117-53ed8yahoreoms76
updated software to include drawing abstraction infrastructure

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
1
 
/* -*- mode: c++; compile-command: "make"; -*- */
 
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
2
/*
3
3
 * propeller-clock.ino
4
4
 *
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
 
 
79
#include <button.h>
78
80
#include "config.h"
79
 
#include "button.h"
80
81
#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"
 
82
#include "mode_switcher.h"
 
83
#include "drawer.h"
91
84
 
92
85
//_____________________________________________________________________________
93
86
//                                                                         data
94
87
 
 
88
 
95
89
// when non-zero, the time (in microseconds) of a new fan pulse that
96
90
// has just occurred, which means that segment drawing needs to be
97
91
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
92
static unsigned long new_pulse_at = 0;
99
93
 
100
94
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
95
static unsigned long last_pulse_at = 0;
102
96
 
103
97
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
98
static unsigned long segment_step = 0;
105
99
 
106
100
// 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;
 
101
static unsigned long segment_step_sub_step = 0;
 
102
static unsigned long segment_step_sub = 0;
 
103
 
 
104
// flag to indicate that the drawing mode should be cycled to the next one
 
105
static bool inc_draw_mode = false;
 
106
 
 
107
// a bounce-managed button
 
108
static Button button( 3 );
118
109
 
119
110
//_____________________________________________________________________________
120
111
//                                                                         code
121
112
 
122
 
// perform button events
123
 
void do_button_events()
 
113
 
 
114
// check for button presses
 
115
void checkButtons()
124
116
{
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;
144
 
                }
 
117
        // update buttons
 
118
        int event = button.update();
 
119
 
 
120
        // handle any events
 
121
        switch( event ) {
 
122
        case 1:
 
123
                inc_draw_mode = true;
 
124
                break;
145
125
        }
146
126
}
147
127
 
148
128
 
 
129
// turn an led on/off
 
130
void ledOn( int num, bool on )
 
131
{
 
132
        if( num < 0 || num > 9 ) return;
 
133
 
 
134
        // convert to pin no.
 
135
        num += 4;
 
136
 
 
137
        // pin 4 needs to be inverted (it's driving a PNP)
 
138
        if( num == 4 ) on = !on;
 
139
 
 
140
        digitalWrite( num, on? HIGH : LOW );
 
141
}
 
142
 
 
143
 
149
144
// draw a display segment
150
 
void draw_next_segment( bool reset )
 
145
void drawNextSegment( bool reset )
151
146
{
 
147
        static ModeSwitcher mode_switcher;
 
148
        static bool init = false;
 
149
 
 
150
        if( !init ) {
 
151
                init = true;
 
152
                mode_switcher.activate();
 
153
        }
 
154
 
152
155
        // keep track of segment
153
156
#if CLOCK_FORWARD
154
157
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
158
161
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
159
162
#endif
160
163
 
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
164
        // 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();
 
165
        Drawer &drawer = mode_switcher.get_drawer();
 
166
        if( reset ) drawer.draw_reset();
 
167
        drawer.draw( segment );
180
168
 
181
169
#if CLOCK_FORWARD
182
170
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
187
175
 
188
176
 
189
177
// calculate time constants when a new pulse has occurred
190
 
void calculate_segment_times()
 
178
void calculateSegmentTimes()
191
179
{
192
180
        // check for overflows, and only recalculate times if there isn't
193
181
        // one (if there is, we'll just go with the last pulse's times)
194
 
        if( _new_pulse_at > _last_pulse_at )
 
182
        if( new_pulse_at > last_pulse_at )
195
183
        {
196
184
                // 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;
 
185
                unsigned long delta = new_pulse_at - last_pulse_at;
 
186
                segment_step = delta / NUM_SEGMENTS;
 
187
                segment_step_sub = 0;
 
188
                segment_step_sub_step = delta % NUM_SEGMENTS;
201
189
        }
202
190
 
203
191
        // now we have dealt with this pulse, save the pulse time and
204
192
        // clear new_pulse_at, ready for the next pulse
205
 
        _last_pulse_at = _new_pulse_at;
206
 
        _new_pulse_at = 0;
 
193
        last_pulse_at = new_pulse_at;
 
194
        new_pulse_at = 0;
207
195
}
208
196
 
209
197
 
210
198
// wait until it is time to draw the next segment or a new pulse has
211
199
// occurred
212
 
void wait_till_end_of_segment( bool reset )
 
200
void waitTillNextSegment( bool reset )
213
201
{
214
202
        static unsigned long end_time = 0;
215
203
 
216
204
        // handle reset
217
205
        if( reset )
218
 
                end_time = _last_pulse_at;
 
206
                end_time = last_pulse_at;
219
207
 
220
208
        // 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;
 
209
        end_time += segment_step;
 
210
        segment_step_sub += segment_step_sub_step;
 
211
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
212
                segment_step_sub -= NUM_SEGMENTS;
225
213
                end_time++;
226
214
        }
227
215
 
228
216
        // wait
229
 
        while( micros() < end_time && !_new_pulse_at );
 
217
        while( micros() < end_time && !new_pulse_at );
230
218
}
231
219
 
232
220
 
233
 
// ISR to handle the pulses from the fan's tachometer
234
 
void fan_pulse_handler()
 
221
// ISR to handle the pulses from the fan's tachiometer
 
222
void fanPulseHandler()
235
223
{
236
224
        // the fan actually sends two pulses per revolution. These pulses
237
225
        // may not be exactly evenly distributed around the rotation, so
242
230
        if( !ignore )
243
231
        {
244
232
                // set a new pulse time
245
 
                _new_pulse_at = micros();
 
233
                new_pulse_at = micros();
246
234
        }
247
235
}
248
236
 
250
238
// main setup
251
239
void setup()
252
240
{
253
 
        // set up an interrupt handler on pin 2 to notice fan pulses
254
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
241
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
242
        attachInterrupt( 0, fanPulseHandler, RISING );
255
243
        digitalWrite( 2, HIGH );
256
244
  
257
245
        // set up output pins (4 to 13) for the led array
261
249
        // set up mode-switch button on pin 3
262
250
        pinMode( 3, INPUT );
263
251
        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();
 
252
        button.add_event_at( 5, 1 );
 
253
        button.add_event_at( 1000, 2 );
 
254
        button.add_event_at( 4000, 3 );
 
255
 
 
256
        // serial comms
 
257
        Serial.begin( 9600 );
288
258
}
289
259
 
290
260
 
292
262
void loop()
293
263
{
294
264
        // 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();
 
265
        bool reset = new_pulse_at? true : false;
299
266
 
300
267
        // only do this stuff at the start of a display cycle, to ensure
301
268
        // that no state changes mid-display
302
269
        if( reset )
303
270
        {
304
 
                // calculate segment times
305
 
                calculate_segment_times();
 
271
                // check buttons
 
272
                checkButtons();
306
273
 
307
274
                // keep track of time
308
 
                Time::update();
309
 
 
310
 
                // perform button events
311
 
                do_button_events();
 
275
                Time &time = Time::get_instance();
 
276
                time.update();
312
277
        }
313
278
 
314
279
        // draw this segment
315
 
        draw_next_segment( reset );
 
280
        drawNextSegment( reset );
 
281
 
 
282
        // do we need to recalculate segment times?
 
283
        if( reset )
 
284
                calculateSegmentTimes();
316
285
 
317
286
        // wait till it's time to draw the next segment
318
 
        wait_till_end_of_segment( reset );
 
287
        waitTillNextSegment( reset );
319
288
}