/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-18 18:29:50 UTC
  • Revision ID: tim@ed.am-20120518182950-t85bn9a21n72uzm8
text messages are now individually enabled and draw()n automatically

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