/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

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