/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.ino

  • Committer: edam
  • Date: 2011-11-04 13:48:15 UTC
  • Revision ID: edam@waxworlds.org-20111104134815-kj7qdhqfbxaj1tng
finished writing up electronics notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
1
 
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
 
/*
3
 
 * propeller-clock.ino
4
 
 *
5
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
6
 
 *
7
 
 * 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
9
 
 * information.
10
 
 *
11
 
 * This program is free software: you can redistribute it and/or modify
12
 
 * it under the terms of the GNU Lesser General Public License as published
13
 
 * by the Free Software Foundation, either version 3 of the License, or
14
 
 * (at your option) any later version.
15
 
 *
16
 
 * This program is distributed in the hope that it will be useful,
17
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
 
 * GNU Lesser General Public License for more details.
20
 
 *
21
 
 * You should have received a copy of the GNU Lesser General Public License
22
 
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23
 
 */
24
 
 
25
 
/******************************************************************************
26
 
 
27
 
Set up:
28
 
 
29
 
 * a PC fan is wired up to a 12V power supply
30
 
 
31
 
 * the fan's SENSE (tachiometer) 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 anf 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 analog 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 tachiometer 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 dicsover 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 "display.h"
80
 
#include "button.h"
81
 
#include "time.h"
82
 
#include "switcher_major_mode.h"
83
 
#include "drawer.h"
84
 
 
85
 
//_____________________________________________________________________________
86
 
//                                                                         data
87
 
 
88
 
 
89
 
// when non-zero, the time (in microseconds) of a new fan pulse that
90
 
// has just occurred, which means that segment drawing needs to be
91
 
// restarted
92
 
static unsigned long new_pulse_at = 0;
93
 
 
94
 
// the time (in microseconds) when the last fan pulse occurred
95
 
static unsigned long last_pulse_at = 0;
96
 
 
97
 
// duration (in microseconds) that a segment should be displayed
98
 
static unsigned long segment_step = 0;
99
 
 
100
 
// 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
 
// 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 };
114
 
 
115
 
//_____________________________________________________________________________
116
 
//                                                                         code
117
 
 
118
 
 
119
 
// perform button events
120
 
void doButtonEvents()
121
 
{
122
 
        // loop through pending events
123
 
        while( int event = button.get_event() )
124
 
        {
125
 
                switch( event )
126
 
                {
127
 
                case 1:
128
 
                        // short press
129
 
                        major_modes[ major_mode ]->press();
130
 
                        break;
131
 
 
132
 
                case 2:
133
 
                        // long press
134
 
                        major_modes[ major_mode ]->long_press();
135
 
                        break;
136
 
 
137
 
                case 3:
138
 
                        // 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
 
 
146
 
                }
147
 
        }
148
 
}
149
 
 
150
 
 
151
 
// draw a display segment
152
 
void drawNextSegment( bool reset )
153
 
{
154
 
        // keep track of segment
155
 
#if CLOCK_FORWARD
156
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
157
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
158
 
#else
159
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
160
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
161
 
#endif
162
 
 
163
 
        // draw
164
 
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
165
 
        if( reset ) drawer.draw_reset();
166
 
        drawer.draw( segment );
167
 
 
168
 
#if CLOCK_FORWARD
169
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
170
 
#else
171
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
172
 
#endif
173
 
}
174
 
 
175
 
 
176
 
// calculate time constants when a new pulse has occurred
177
 
void calculateSegmentTimes()
178
 
{
179
 
        // check for overflows, and only recalculate times if there isn't
180
 
        // one (if there is, we'll just go with the last pulse's times)
181
 
        if( new_pulse_at > last_pulse_at )
182
 
        {
183
 
                // 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;
188
 
        }
189
 
 
190
 
        // now we have dealt with this pulse, save the pulse time and
191
 
        // clear new_pulse_at, ready for the next pulse
192
 
        last_pulse_at = new_pulse_at;
193
 
        new_pulse_at = 0;
194
 
}
195
 
 
196
 
 
197
 
// wait until it is time to draw the next segment or a new pulse has
198
 
// occurred
199
 
void waitTillEndOfSegment( bool reset )
200
 
{
201
 
        static unsigned long end_time = 0;
202
 
 
203
 
        // handle reset
204
 
        if( reset )
205
 
                end_time = last_pulse_at;
206
 
 
207
 
        // 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;
212
 
                end_time++;
213
 
        }
214
 
 
215
 
        // wait
216
 
        while( micros() < end_time && !new_pulse_at );
217
 
}
218
 
 
219
 
 
220
 
// ISR to handle the pulses from the fan's tachiometer
221
 
void fanPulseHandler()
222
 
{
223
 
        // the fan actually sends two pulses per revolution. These pulses
224
 
        // may not be exactly evenly distributed around the rotation, so
225
 
        // we can't recalculate times on every pulse. Instead, we ignore
226
 
        // every other pulse so timings are based on a complete rotation.
227
 
        static bool ignore = true;
228
 
        ignore = !ignore;
229
 
        if( !ignore )
230
 
        {
231
 
                // set a new pulse time
232
 
                new_pulse_at = micros();
233
 
        }
234
 
}
235
 
 
236
 
 
237
 
// main setup
238
 
void setup()
239
 
{
240
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
241
 
        attachInterrupt( 0, fanPulseHandler, RISING );
242
 
        digitalWrite( 2, HIGH );
243
 
  
244
 
        // set up output pins (4 to 13) for the led array
245
 
        for( int a = 4; a < 14; a++ )
246
 
                pinMode( a, OUTPUT );
247
 
 
248
 
        // set up mode-switch button on pin 3
249
 
        pinMode( 3, INPUT );
250
 
        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;
256
 
        int mode = 0;
257
 
        major_modes[ mode++ ] = &switcher_major_mode;
258
 
        major_modes[ 0 ]->activate();
259
 
}
260
 
 
261
 
 
262
 
// main loop
263
 
void loop()
264
 
{
265
 
        // if there has been a new pulse, we'll be resetting the display
266
 
        bool reset = new_pulse_at? true : false;
267
 
 
268
 
        // update button
269
 
        button.update();
270
 
 
271
 
        // only do this stuff at the start of a display cycle, to ensure
272
 
        // that no state changes mid-display
273
 
        if( reset )
274
 
        {
275
 
                // calculate segment times
276
 
                calculateSegmentTimes();
277
 
 
278
 
                // keep track of time
279
 
                Time &time = Time::get_instance();
280
 
                time.update();
281
 
 
282
 
                // perform button events
283
 
                doButtonEvents();
284
 
        }
285
 
 
286
 
        // draw this segment
287
 
        drawNextSegment( reset );
288
 
 
289
 
        // wait till it's time to draw the next segment
290
 
        waitTillEndOfSegment( reset );
291
 
}