/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: 2013-03-31 17:07:36 UTC
  • Revision ID: tim@ed.am-20130331170736-hphm2hg0y6l7w6z1
made rtc-test's DS1307 library a symlink to the main one in src/util

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