/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-09 23:42:20 UTC
  • Revision ID: tim@ed.am-20120309234220-xr1vxzve0o5n2oss
added support for eclipse project and converted to a manual Makefile

Show diffs side-by-side

added added

removed removed

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