/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 propeller-clock/propeller-clock.pde

  • Committer: edam
  • Date: 2011-11-17 13:05:46 UTC
  • Revision ID: edam@waxworlds.org-20111117130546-by4v2vm98emidlrk
updated propeller-clock code, added GPL text and renamed fan-test

Show diffs side-by-side

added added

removed removed

Lines of Context:
propeller-clock/propeller-clock.pde
1
 
/* -*- mode: c++; compile-command: "make"; -*- */
2
1
/*
3
 
 * propeller-clock.ino
 
2
 * propeller-clock.pde
4
3
 *
5
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
4
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
6
5
 *
7
6
 * This file is part of propeller-clock (hereafter referred to as "this
8
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
7
 * program"). See http://ed.am/software/arduino/propeller-clock for more
9
8
 * information.
10
9
 *
11
10
 * This program is free software: you can redistribute it and/or modify
22
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23
22
 */
24
23
 
25
 
/******************************************************************************
26
 
 
27
 
Set up:
28
 
 
29
 
 * a PC fan is wired up to a 12V power supply
30
 
 
31
 
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
32
 
   Arduino.
33
 
 
34
 
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
35
 
   LED on pin 4 is in the centre of the clock face and the LED on pin
36
 
   13 is at the outside.
37
 
 
38
 
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
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.
41
 
 
42
 
 * a button should be attached to pin 3 that grounds it when pressed.
43
 
 
44
 
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
45
 
 
46
 
Implementation details:
47
 
 
48
 
 * for a schematic, see ../project/propeller-clock.sch.
49
 
 
50
 
 * the timing of the drawing of the clock face is recalculated with
51
 
   every rotation of the propeller.
52
 
    
53
 
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
54
 
   software skips every other one. This means that the clock may
55
 
   appear upside-down if started with the propeller in the wrong
56
 
   position. You will need to experiment to discover the position that
57
 
   the propeller must be in when starting the clock.
58
 
    
59
 
Usage instructions:
60
 
 
61
 
 * pressing the button cycles between variations of the current
62
 
   display mode.
63
 
  
64
 
 * pressing and holding the button for a second cycles between display
65
 
   modes (e.g., analogue and digital).
66
 
 
67
 
 * pressing and holding the button for 5 seconds enters "time set"
68
 
   mode. In this mode, the following applies:
69
 
    - the field that is being set flashes
70
 
    - pressing the button increments the field currently being set
71
 
    - pressing and holding the button for a second cycles through the
72
 
      fields that can be set
73
 
    - pressing and holding the button for 5 seconds sets the time and
74
 
      exits "time set" mode
75
 
 
76
 
******************************************************************************/
77
 
 
78
 
#include "config.h"
79
 
#include "button.h"
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"
91
 
 
92
24
//_____________________________________________________________________________
93
25
//                                                                         data
94
26
 
 
27
 
95
28
// when non-zero, the time (in microseconds) of a new fan pulse that
96
29
// has just occurred, which means that segment drawing needs to be
97
30
// restarted
98
 
static unsigned long _new_pulse_at = 0;
 
31
static unsigned long new_pulse_at = 0;
99
32
 
100
33
// the time (in microseconds) when the last fan pulse occurred
101
 
static unsigned long _last_pulse_at = 0;
 
34
static unsigned long last_pulse_at = 0;
102
35
 
103
36
// duration (in microseconds) that a segment should be displayed
104
 
static unsigned long _segment_step = 0;
 
37
static unsigned long segment_step = 0;
105
38
 
106
39
// 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;
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;
 
40
static unsigned long segment_step_sub_step = 0;
 
41
static unsigned long segment_step_sub = 0;
 
42
 
 
43
// display mode
 
44
static
 
45
 
118
46
 
119
47
//_____________________________________________________________________________
120
48
//                                                                         code
121
49
 
122
 
// perform button events
123
 
void do_button_events()
 
50
 
 
51
// ISR to handle the pulses from the fan's tachiometer
 
52
void fanPulseHandler()
124
53
{
125
 
        // loop through pending events
126
 
        while( int event = _button.get_event() )
 
54
        // the fan actually sends two pulses per revolution. These pulses
 
55
        // may not be exactly evenly distributed around the rotation, so
 
56
        // we can't recalculate times on every pulse. Instead, we ignore
 
57
        // every other pulse so timings are based on a complete rotation.
 
58
        static bool ignore = true;
 
59
        ignore = !ignore;
 
60
        if( !ignore )
127
61
        {
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
 
                }
 
62
                // set a new pulse time
 
63
                new_pulse_at = micros();
145
64
        }
146
65
}
147
66
 
148
67
 
149
 
// draw a display segment
150
 
void draw_next_segment( bool reset )
 
68
// draw a particular segment
 
69
void drawNextSegment( bool reset )
151
70
{
152
 
        // keep track of segment
153
 
#if CLOCK_FORWARD
154
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
155
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
156
 
#else
157
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
158
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
159
 
#endif
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
 
 
172
 
        // draw
173
 
        _modes[ _mode ]->draw( segment );
174
 
 
175
 
        // draw text
176
 
        Text::draw( segment );
177
 
 
178
 
        // draw text rednerer's buffer
179
 
        TextRenderer::output_buffer();
180
 
 
181
 
#if CLOCK_FORWARD
182
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
183
 
#else
184
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
185
 
#endif
 
71
        static unsigned int segment = 0;
 
72
        if( reset ) segment = 0;
 
73
        segment++;
 
74
 
 
75
        for( int a = 0; a < 10; a++ )
 
76
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
186
77
}
187
78
 
188
79
 
189
80
// calculate time constants when a new pulse has occurred
190
 
void calculate_segment_times()
 
81
void calculateSegmentTimes()
191
82
{
192
83
        // check for overflows, and only recalculate times if there isn't
193
84
        // one (if there is, we'll just go with the last pulse's times)
194
 
        if( _new_pulse_at > _last_pulse_at )
 
85
        if( new_pulse_at > last_pulse_at )
195
86
        {
196
87
                // 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;
 
88
                unsigned long delta = new_pulse_at - last_pulse_at;
 
89
                segment_step = delta / NUM_SEGMENTS;
 
90
                segment_step_sub = 0;
 
91
                segment_step_sub_step = delta % NUM_SEGMENTS;
201
92
        }
202
93
 
203
94
        // now we have dealt with this pulse, save the pulse time and
204
95
        // clear new_pulse_at, ready for the next pulse
205
 
        _last_pulse_at = _new_pulse_at;
206
 
        _new_pulse_at = 0;
 
96
        last_pulse_at = new_pulse_at;
 
97
        new_pulse_at = 0;
207
98
}
208
99
 
209
100
 
210
101
// wait until it is time to draw the next segment or a new pulse has
211
102
// occurred
212
 
void wait_till_end_of_segment( bool reset )
 
103
void waitTillNextSegment( bool reset )
213
104
{
214
105
        static unsigned long end_time = 0;
215
106
 
216
107
        // handle reset
217
108
        if( reset )
218
 
                end_time = _last_pulse_at;
 
109
                end_time = last_pulse_at;
219
110
 
220
111
        // 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;
 
112
        end_time += segment_step;
 
113
        semgment_step_sub += semgment_step_sub_step;
 
114
        if( semgment_step_sub >= NUM_SEGMENTS ) {
 
115
                semgment_step_sub -= NUM_SEGMENTS;
225
116
                end_time++;
226
117
        }
227
118
 
228
119
        // wait
229
 
        while( micros() < end_time && !_new_pulse_at );
230
 
}
231
 
 
232
 
 
233
 
// ISR to handle the pulses from the fan's tachometer
234
 
void fan_pulse_handler()
235
 
{
236
 
        // the fan actually sends two pulses per revolution. These pulses
237
 
        // may not be exactly evenly distributed around the rotation, so
238
 
        // we can't recalculate times on every pulse. Instead, we ignore
239
 
        // every other pulse so timings are based on a complete rotation.
240
 
        static bool ignore = true;
241
 
        ignore = !ignore;
242
 
        if( !ignore )
243
 
        {
244
 
                // set a new pulse time
245
 
                _new_pulse_at = micros();
246
 
        }
 
120
        while( micros() < end_time && !new_pulse_at );
247
121
}
248
122
 
249
123
 
250
124
// main setup
251
125
void setup()
252
126
{
253
 
        // set up an interrupt handler on pin 2 to notice fan pulses
254
 
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
127
        // set up an interrupt handler on pin 2 to nitice fan pulses
 
128
        attachInterrupt( 0, fanPulseHandler, RISING );
255
129
        digitalWrite( 2, HIGH );
256
130
  
257
131
        // set up output pins (4 to 13) for the led array
258
132
        for( int a = 4; a < 14; a++ )
259
133
                pinMode( a, OUTPUT );
260
134
 
261
 
        // set up mode-switch button on pin 3
262
 
        pinMode( 3, INPUT );
263
 
        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::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();
 
135
        // serial comms
 
136
        Serial.begin( 9600 );
288
137
}
289
138
 
290
139
 
292
141
void loop()
293
142
{
294
143
        // 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();
299
 
 
300
 
        // only do this stuff at the start of a display cycle, to ensure
301
 
        // that no state changes mid-display
302
 
        if( reset )
303
 
        {
304
 
                // calculate segment times
305
 
                calculate_segment_times();
306
 
 
307
 
                // keep track of time
308
 
                Time::update();
309
 
 
310
 
                // perform button events
311
 
                do_button_events();
312
 
        }
 
144
        bool reset = new_pulse_at? true : false;
313
145
 
314
146
        // draw this segment
315
 
        draw_next_segment( reset );
 
147
        drawNextSegment( reset );
 
148
 
 
149
        // do we need to recalculate segment times?
 
150
        if( reset )
 
151
                calculateSegmentTimes();
316
152
 
317
153
        // wait till it's time to draw the next segment
318
 
        wait_till_end_of_segment( reset );
 
154
        waitTillNextSegment( reset );
319
155
}