/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: edam
  • Date: 2012-05-18 12:11:01 UTC
  • Revision ID: tim@ed.am-20120518121101-0wik922hyvjkcjdi
switched back to using classes for modes

Show diffs side-by-side

added added

removed removed

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