/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-05-23 23:02:50 UTC
  • Revision ID: tim@ed.am-20120523230250-3pls2u6zt3av0uam
fixed text glitch; extended all modes; added screen flip super-long press;
added button unpress debounde; moved interim button press ignoration to
settings mode; fixed left-over led issue; finished for demo!

Show diffs side-by-side

added added

removed removed

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