/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-03-23 15:56:07 UTC
  • Revision ID: tim@ed.am-20120323155607-6h8pc0c6o35nl179
switch button to no interim presses during settings mode; added NVRAM support

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.cc
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 "analogue_clock.h"
 
83
#include "digital_clock.h"
 
84
#include "test_pattern.h"
 
85
#include "settings_mode.h"
 
86
#include "text.h"
 
87
#include "text_renderer.h"
 
88
#include "common.h"
84
89
 
85
90
//_____________________________________________________________________________
86
91
//                                                                         data
87
92
 
88
 
 
89
93
// when non-zero, the time (in microseconds) of a new fan pulse that
90
94
// has just occurred, which means that segment drawing needs to be
91
95
// restarted
92
 
static unsigned long new_pulse_at = 0;
 
96
static unsigned long _new_pulse_at = 0;
93
97
 
94
98
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long last_pulse_at = 0;
 
99
static unsigned long _last_pulse_at = 0;
96
100
 
97
101
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long segment_step = 0;
 
102
static unsigned long _segment_step = 0;
99
103
 
100
104
// 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;
 
105
static unsigned long _segment_step_sub_step = 0;
 
106
static unsigned long _segment_step_sub = 0;
103
107
 
104
108
// 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
 
 
112
 
// major modes
113
 
static MajorMode *major_modes[ MAX_MAJOR_MODES ] = { 0 };
 
109
static Button _button( 3 );
 
110
 
 
111
// modes
 
112
static int _major_mode = 0;
 
113
static int _minor_mode = 0;
 
114
 
 
115
#define MAIN_MODE_IDX 1
 
116
#define SETTINGS_MODE_IDX 0
 
117
 
 
118
#define ANALOGUE_CLOCK_IDX 0
 
119
#define DIGITAL_CLOCK_IDX 1
 
120
#define TEST_PATTERN_IDX 2
114
121
 
115
122
//_____________________________________________________________________________
116
123
//                                                                         code
117
124
 
118
125
 
 
126
// activate the current minor mode
 
127
void activate_minor_mode()
 
128
{
 
129
        // reset text
 
130
        Text::reset();
 
131
        leds_off();
 
132
 
 
133
        // give the mode a chance to init
 
134
        switch( _minor_mode ) {
 
135
        case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
 
136
        case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
 
137
        }
 
138
}
 
139
 
 
140
 
 
141
// activate major mode
 
142
void activate_major_mode()
 
143
{
 
144
        // reset text
 
145
        Text::reset();
 
146
        leds_off();
 
147
 
 
148
        // reset buttons
 
149
        _button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
 
150
 
 
151
        // give the mode a chance to init
 
152
        switch( _major_mode ) {
 
153
        case MAIN_MODE_IDX: activate_minor_mode(); break;
 
154
        case SETTINGS_MODE_IDX: settings_mode_activate(); break;
 
155
        }
 
156
}
 
157
 
 
158
 
119
159
// perform button events
120
 
void doButtonEvents()
 
160
void do_button_events()
121
161
{
122
162
        // loop through pending events
123
 
        while( int event = button.get_event() )
 
163
        while( int event = _button.get_event() )
124
164
        {
125
165
                switch( event )
126
166
                {
127
167
                case 1:
128
168
                        // short press
129
 
                        major_modes[ major_mode ]->press();
 
169
                        switch( _major_mode ) {
 
170
                        case MAIN_MODE_IDX:
 
171
                                switch( _minor_mode ) {
 
172
                                case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
 
173
                                case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
 
174
                                }
 
175
                                break;
 
176
                        case SETTINGS_MODE_IDX: settings_mode_press(); break;
 
177
                        }
130
178
                        break;
131
179
 
132
180
                case 2:
133
181
                        // long press
134
 
                        major_modes[ major_mode ]->long_press();
 
182
                        switch( _major_mode ) {
 
183
                        case MAIN_MODE_IDX:
 
184
                                if( ++_minor_mode >= 3 )
 
185
                                        _minor_mode = 0;
 
186
                                activate_minor_mode();
 
187
                                break;
 
188
                        case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
 
189
                        }
135
190
                        break;
136
191
 
137
192
                case 3:
138
193
                        // 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();
 
194
                        if( ++_major_mode > 1 )
 
195
                                _major_mode = 0;
 
196
                        activate_major_mode();
144
197
                        break;
145
 
 
146
198
                }
147
199
        }
148
200
}
149
201
 
150
202
 
151
203
// draw a display segment
152
 
void drawNextSegment( bool reset )
 
204
void draw_next_segment( bool reset )
153
205
{
154
206
        // keep track of segment
155
207
#if CLOCK_FORWARD
160
212
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
161
213
#endif
162
214
 
 
215
        // reset the text renderer
 
216
        TextRenderer::reset_buffer();
 
217
 
 
218
        // frame reset
 
219
        if( reset ) {
 
220
                switch( _major_mode ) {
 
221
                case MAIN_MODE_IDX:
 
222
                        switch( _minor_mode ) {
 
223
                        case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
 
224
                        case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
 
225
                        }
 
226
                        break;
 
227
                case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
 
228
                }
 
229
 
 
230
                // tell the text services we're starting a new frame
 
231
                Text::draw_reset();
 
232
        }
 
233
 
163
234
        // draw
164
 
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
165
 
        if( reset ) drawer.draw_reset();
166
 
        drawer.draw( segment );
 
235
        switch( _major_mode ) {
 
236
        case MAIN_MODE_IDX:
 
237
                switch( _minor_mode ) {
 
238
                case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
 
239
                case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
 
240
                case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
 
241
                }
 
242
                break;
 
243
        case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
 
244
        }
 
245
 
 
246
        // draw any text that was rendered
 
247
        TextRenderer::output_buffer();
167
248
 
168
249
#if CLOCK_FORWARD
169
250
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
174
255
 
175
256
 
176
257
// calculate time constants when a new pulse has occurred
177
 
void calculateSegmentTimes()
 
258
void calculate_segment_times()
178
259
{
179
260
        // check for overflows, and only recalculate times if there isn't
180
261
        // one (if there is, we'll just go with the last pulse's times)
181
 
        if( new_pulse_at > last_pulse_at )
 
262
        if( _new_pulse_at > _last_pulse_at )
182
263
        {
183
264
                // 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;
 
265
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
266
                _segment_step = delta / NUM_SEGMENTS;
 
267
                _segment_step_sub = 0;
 
268
                _segment_step_sub_step = delta % NUM_SEGMENTS;
188
269
        }
189
270
 
190
271
        // now we have dealt with this pulse, save the pulse time and
191
272
        // clear new_pulse_at, ready for the next pulse
192
 
        last_pulse_at = new_pulse_at;
193
 
        new_pulse_at = 0;
 
273
        _last_pulse_at = _new_pulse_at;
 
274
        _new_pulse_at = 0;
194
275
}
195
276
 
196
277
 
197
278
// wait until it is time to draw the next segment or a new pulse has
198
279
// occurred
199
 
void waitTillEndOfSegment( bool reset )
 
280
void wait_till_end_of_segment( bool reset )
200
281
{
201
282
        static unsigned long end_time = 0;
202
283
 
203
284
        // handle reset
204
285
        if( reset )
205
 
                end_time = last_pulse_at;
 
286
                end_time = _last_pulse_at;
206
287
 
207
288
        // 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;
 
289
        end_time += _segment_step;
 
290
        _segment_step_sub += _segment_step_sub_step;
 
291
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
292
                _segment_step_sub -= NUM_SEGMENTS;
212
293
                end_time++;
213
294
        }
214
295
 
215
296
        // wait
216
 
        while( micros() < end_time && !new_pulse_at );
 
297
        while( micros() < end_time && !_new_pulse_at );
217
298
}
218
299
 
219
300
 
220
301
// ISR to handle the pulses from the fan's tachiometer
221
 
void fanPulseHandler()
 
302
void fan_pulse_handler()
222
303
{
223
304
        // the fan actually sends two pulses per revolution. These pulses
224
305
        // may not be exactly evenly distributed around the rotation, so
229
310
        if( !ignore )
230
311
        {
231
312
                // set a new pulse time
232
 
                new_pulse_at = micros();
 
313
                _new_pulse_at = micros();
233
314
        }
234
315
}
235
316
 
238
319
void setup()
239
320
{
240
321
        // set up an interrupt handler on pin 2 to nitice fan pulses
241
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
322
        attachInterrupt( 0, fan_pulse_handler, RISING );
242
323
        digitalWrite( 2, HIGH );
243
324
  
244
325
        // set up output pins (4 to 13) for the led array
248
329
        // set up mode-switch button on pin 3
249
330
        pinMode( 3, INPUT );
250
331
        digitalWrite( 3, HIGH );
251
 
        static int event_times[] = { 5, 1000, 4000, 0 };
252
 
        button.set_event_times( event_times );
253
 
 
254
 
        // set up major modes
255
 
        static SwitcherMajorMode switcher_major_mode;
256
 
        int mode = 0;
257
 
        major_modes[ mode++ ] = &switcher_major_mode;
258
 
        major_modes[ 0 ]->activate();
 
332
        static int event_times[] = { 5, 500, 4000, 0 };
 
333
        _button.set_event_times( event_times );
 
334
 
 
335
        // initialise RTC
 
336
        Time::init();
 
337
 
 
338
        // init text renderer
 
339
        TextRenderer::init();
 
340
 
 
341
        // activate the minor mode
 
342
        activate_major_mode();
259
343
}
260
344
 
261
345
 
263
347
void loop()
264
348
{
265
349
        // if there has been a new pulse, we'll be resetting the display
266
 
        bool reset = new_pulse_at? true : false;
 
350
        bool reset = _new_pulse_at? true : false;
267
351
 
268
352
        // update button
269
 
        button.update();
 
353
        _button.update();
270
354
 
271
355
        // only do this stuff at the start of a display cycle, to ensure
272
356
        // that no state changes mid-display
273
357
        if( reset )
274
358
        {
275
359
                // calculate segment times
276
 
                calculateSegmentTimes();
 
360
                calculate_segment_times();
277
361
 
278
362
                // keep track of time
279
 
                Time &time = Time::get_instance();
280
 
                time.update();
 
363
                Time::update();
281
364
 
282
365
                // perform button events
283
 
                doButtonEvents();
 
366
                do_button_events();
284
367
        }
285
368
 
286
369
        // draw this segment
287
 
        drawNextSegment( reset );
 
370
        draw_next_segment( reset );
288
371
 
289
372
        // wait till it's time to draw the next segment
290
 
        waitTillEndOfSegment( reset );
 
373
        wait_till_end_of_segment( reset );
291
374
}