/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 14:54:33 UTC
  • Revision ID: edam@waxworlds.org-20120225145433-kih8qs45x05cum46
removed Bounce library and updated/fixed new code

Show diffs side-by-side

added added

removed removed

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