/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-29 21:56:32 UTC
  • Revision ID: edam@waxworlds.org-20120229215632-kypb9491vx7bicef
moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages

Show diffs side-by-side

added added

removed removed

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:
76
76
******************************************************************************/
77
77
 
78
78
#include "config.h"
 
79
#include "display.h"
79
80
#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 "switcher_major_mode.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;
 
101
static unsigned long segment_step_sub_step = 0;
 
102
static unsigned long segment_step_sub = 0;
109
103
 
110
104
// the button
111
 
static Button _button( 3 );
 
105
static Button button( 3 );
 
106
 
 
107
// major mode
 
108
static int major_mode = 0;
 
109
 
 
110
#define MAX_MAJOR_MODES 5
112
111
 
113
112
// major modes
114
 
static MajorMode *_modes[ 3 ];
115
 
 
116
 
// current major mode
117
 
static int _mode = 0;
118
 
 
119
 
// interupt handler's "ignore every other" flag
120
 
static bool _pulse_ignore = true;
 
113
static MajorMode *major_modes[ MAX_MAJOR_MODES ] = { 0 };
121
114
 
122
115
//_____________________________________________________________________________
123
116
//                                                                         code
124
117
 
 
118
 
125
119
// perform button events
126
 
void do_button_events()
 
120
void doButtonEvents()
127
121
{
128
122
        // loop through pending events
129
 
        while( int event = _button.get_event() )
 
123
        while( int event = button.get_event() )
130
124
        {
131
125
                switch( event )
132
126
                {
133
127
                case 1:
134
128
                        // short press
135
 
                        _modes[ _mode ]->press();
 
129
                        major_modes[ major_mode ]->press();
136
130
                        break;
 
131
 
137
132
                case 2:
138
133
                        // long press
139
 
                        _modes[ _mode ]->long_press();
 
134
                        major_modes[ major_mode ]->long_press();
140
135
                        break;
 
136
 
141
137
                case 3:
142
138
                        // looooong press (change major mode)
143
 
                        _modes[ _mode ]->deactivate();
144
 
                        if( !_modes[ ++_mode ] ) _mode = 0;
145
 
                        _modes[ _mode ]->activate();
146
 
                        break;
147
 
                case 4:
148
 
                        // switch display upside-down
149
 
                        _pulse_ignore = !_pulse_ignore;
150
 
                        break;
 
139
                        do {
 
140
                                if( ++major_mode >= MAX_MAJOR_MODES )
 
141
                                        major_mode = 0;
 
142
                        } while( major_modes[ major_mode ] == NULL );
 
143
                        major_modes[ major_mode ]->activate();
 
144
                        break;
 
145
 
151
146
                }
152
147
        }
153
148
}
154
149
 
155
150
 
156
151
// draw a display segment
157
 
void draw_next_segment( bool reset )
 
152
void drawNextSegment( bool reset )
158
153
{
159
154
        // keep track of segment
160
 
        static int segment = 0;
161
155
#if CLOCK_FORWARD
 
156
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
162
157
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
163
158
#else
 
159
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
164
160
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
165
161
#endif
166
162
 
167
 
        // reset the text renderer's buffer
168
 
        TextRenderer::reset_buffer();
169
 
 
170
 
        if( reset )
171
 
        {
172
 
                _modes[ _mode ]->draw_reset();
173
 
 
174
 
                // tell the text services we're starting a new frame
175
 
                Text::draw_reset();
176
 
        }
177
 
 
178
163
        // draw
179
 
        _modes[ _mode ]->draw( segment );
180
 
 
181
 
        // draw text
182
 
        Text::draw( segment );
183
 
 
184
 
        // draw text rednerer's buffer
185
 
        TextRenderer::output_buffer();
 
164
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
 
165
        if( reset ) drawer.draw_reset();
 
166
        drawer.draw( segment );
186
167
 
187
168
#if CLOCK_FORWARD
188
169
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
193
174
 
194
175
 
195
176
// calculate time constants when a new pulse has occurred
196
 
void calculate_segment_times()
 
177
void calculateSegmentTimes()
197
178
{
198
179
        // check for overflows, and only recalculate times if there isn't
199
180
        // one (if there is, we'll just go with the last pulse's times)
200
 
        if( _new_pulse_at > _last_pulse_at )
 
181
        if( new_pulse_at > last_pulse_at )
201
182
        {
202
183
                // new segment stepping times
203
 
                unsigned long delta = _new_pulse_at - _last_pulse_at;
204
 
                _segment_step = delta / NUM_SEGMENTS;
205
 
                _segment_step_sub = 0;
206
 
                _segment_step_sub_step = delta % NUM_SEGMENTS;
 
184
                unsigned long delta = new_pulse_at - last_pulse_at;
 
185
                segment_step = delta / NUM_SEGMENTS;
 
186
                segment_step_sub = 0;
 
187
                segment_step_sub_step = delta % NUM_SEGMENTS;
207
188
        }
208
189
 
209
190
        // now we have dealt with this pulse, save the pulse time and
210
191
        // clear new_pulse_at, ready for the next pulse
211
 
        _last_pulse_at = _new_pulse_at;
212
 
        _new_pulse_at = 0;
 
192
        last_pulse_at = new_pulse_at;
 
193
        new_pulse_at = 0;
213
194
}
214
195
 
215
196
 
216
197
// wait until it is time to draw the next segment or a new pulse has
217
198
// occurred
218
 
void wait_till_end_of_segment( bool reset )
 
199
void waitTillEndOfSegment( bool reset )
219
200
{
220
201
        static unsigned long end_time = 0;
221
202
 
222
203
        // handle reset
223
204
        if( reset )
224
 
                end_time = _last_pulse_at;
 
205
                end_time = last_pulse_at;
225
206
 
226
207
        // work out the time that this segment should be displayed until
227
 
        end_time += _segment_step;
228
 
        _segment_step_sub += _segment_step_sub_step;
229
 
        if( _segment_step_sub >= NUM_SEGMENTS ) {
230
 
                _segment_step_sub -= NUM_SEGMENTS;
 
208
        end_time += segment_step;
 
209
        segment_step_sub += segment_step_sub_step;
 
210
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
211
                segment_step_sub -= NUM_SEGMENTS;
231
212
                end_time++;
232
213
        }
233
214
 
234
215
        // wait
235
 
        while( micros() < end_time && !_new_pulse_at );
 
216
        while( micros() < end_time && !new_pulse_at );
236
217
}
237
218
 
238
219
 
239
 
// ISR to handle the pulses from the fan's tachometer
240
 
void fan_pulse_handler()
 
220
// ISR to handle the pulses from the fan's tachiometer
 
221
void fanPulseHandler()
241
222
{
242
223
        // the fan actually sends two pulses per revolution. These pulses
243
224
        // may not be exactly evenly distributed around the rotation, so
244
225
        // we can't recalculate times on every pulse. Instead, we ignore
245
226
        // every other pulse so timings are based on a complete rotation.
246
 
        _pulse_ignore = !_pulse_ignore;
247
 
        if( !_pulse_ignore )
 
227
        static bool ignore = true;
 
228
        ignore = !ignore;
 
229
        if( !ignore )
248
230
        {
249
231
                // set a new pulse time
250
 
                _new_pulse_at = micros();
 
232
                new_pulse_at = micros();
251
233
        }
252
234
}
253
235
 
255
237
// main setup
256
238
void setup()
257
239
{
258
 
        // set up an interrupt handler on pin 2 to notice fan pulses
259
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
240
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
241
        attachInterrupt( 0, fanPulseHandler, RISING );
260
242
        digitalWrite( 2, HIGH );
261
243
  
262
244
        // set up output pins (4 to 13) for the led array
266
248
        // set up mode-switch button on pin 3
267
249
        pinMode( 3, INPUT );
268
250
        digitalWrite( 3, HIGH );
269
 
        static int event_times[] = { 10, 500, 2000, 4000, 0 };
270
 
        _button.set_event_times( event_times );
271
 
 
272
 
        // initialise RTC
273
 
        Time::load_time();
274
 
 
275
 
        // init text renderer
276
 
        TextRenderer::init();
277
 
 
278
 
        // reset text
279
 
        Text::reset();
280
 
        leds_off();
281
 
 
282
 
        static SwitcherMajorMode switcher;
283
 
        static SettingsMajorMode settings( _button );
284
 
 
285
 
        // add major modes
 
251
        static int event_times[] = { 5, 500, 4000, 0 };
 
252
        button.set_event_times( event_times );
 
253
 
 
254
        // set up major modes
 
255
        static SwitcherMajorMode switcher_major_mode;
286
256
        int mode = 0;
287
 
        _modes[ mode++ ] = &switcher;
288
 
        _modes[ mode++ ] = &settings;
289
 
        _modes[ mode ] = 0;
290
 
 
291
 
        // activate the current major mode
292
 
        _modes[ _mode ]->activate();
 
257
        major_modes[ mode++ ] = &switcher_major_mode;
 
258
        major_modes[ 0 ]->activate();
293
259
}
294
260
 
295
261
 
297
263
void loop()
298
264
{
299
265
        // if there has been a new pulse, we'll be resetting the display
300
 
        bool reset = _new_pulse_at? true : false;
 
266
        bool reset = new_pulse_at? true : false;
301
267
 
302
268
        // update button
303
 
        _button.update();
 
269
        button.update();
304
270
 
305
271
        // only do this stuff at the start of a display cycle, to ensure
306
272
        // that no state changes mid-display
307
273
        if( reset )
308
274
        {
309
275
                // calculate segment times
310
 
                calculate_segment_times();
 
276
                calculateSegmentTimes();
311
277
 
312
278
                // keep track of time
313
 
                Time::update();
 
279
                Time &time = Time::get_instance();
 
280
                time.update();
314
281
 
315
282
                // perform button events
316
 
                do_button_events();
 
283
                doButtonEvents();
317
284
        }
318
285
 
319
286
        // draw this segment
320
 
        draw_next_segment( reset );
 
287
        drawNextSegment( reset );
321
288
 
322
289
        // wait till it's time to draw the next segment
323
 
        wait_till_end_of_segment( reset );
 
290
        waitTillEndOfSegment( reset );
324
291
}