/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: 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.cc
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
 
#include "Arduino.h"
85
 
 
86
 
//_____________________________________________________________________________
87
 
//                                                                         data
88
 
 
89
 
 
90
 
// when non-zero, the time (in microseconds) of a new fan pulse that
91
 
// has just occurred, which means that segment drawing needs to be
92
 
// restarted
93
 
static unsigned long new_pulse_at = 0;
94
 
 
95
 
// the time (in microseconds) when the last fan pulse occurred
96
 
static unsigned long last_pulse_at = 0;
97
 
 
98
 
// duration (in microseconds) that a segment should be displayed
99
 
static unsigned long segment_step = 0;
100
 
 
101
 
// remainder after divisor and a tally of the remainders for each segment
102
 
static unsigned long segment_step_sub_step = 0;
103
 
static unsigned long segment_step_sub = 0;
104
 
 
105
 
// the button
106
 
static Button button( 3 );
107
 
 
108
 
// major mode
109
 
static int major_mode = 0;
110
 
 
111
 
#define MAX_MAJOR_MODES 5
112
 
 
113
 
// major modes
114
 
static MajorMode *major_modes[ MAX_MAJOR_MODES ] = { 0 };
115
 
 
116
 
//_____________________________________________________________________________
117
 
//                                                                         code
118
 
 
119
 
 
120
 
// perform button events
121
 
void doButtonEvents()
122
 
{
123
 
        // loop through pending events
124
 
        while( int event = button.get_event() )
125
 
        {
126
 
                switch( event )
127
 
                {
128
 
                case 1:
129
 
                        // short press
130
 
                        major_modes[ major_mode ]->press();
131
 
                        break;
132
 
 
133
 
                case 2:
134
 
                        // long press
135
 
                        major_modes[ major_mode ]->long_press();
136
 
                        break;
137
 
 
138
 
                case 3:
139
 
                        // looooong press (change major mode)
140
 
                        do {
141
 
                                if( ++major_mode >= MAX_MAJOR_MODES )
142
 
                                        major_mode = 0;
143
 
                        } while( major_modes[ major_mode ] == NULL );
144
 
                        major_modes[ major_mode ]->activate();
145
 
                        break;
146
 
 
147
 
                }
148
 
        }
149
 
}
150
 
 
151
 
 
152
 
// draw a display segment
153
 
void drawNextSegment( bool reset )
154
 
{
155
 
        // keep track of segment
156
 
#if CLOCK_FORWARD
157
 
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
158
 
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
159
 
#else
160
 
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
161
 
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
162
 
#endif
163
 
 
164
 
        // draw
165
 
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
166
 
        if( reset ) drawer.draw_reset();
167
 
        drawer.draw( segment );
168
 
 
169
 
#if CLOCK_FORWARD
170
 
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
171
 
#else
172
 
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
173
 
#endif
174
 
}
175
 
 
176
 
 
177
 
// calculate time constants when a new pulse has occurred
178
 
void calculateSegmentTimes()
179
 
{
180
 
        // check for overflows, and only recalculate times if there isn't
181
 
        // one (if there is, we'll just go with the last pulse's times)
182
 
        if( new_pulse_at > last_pulse_at )
183
 
        {
184
 
                // 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;
189
 
        }
190
 
 
191
 
        // now we have dealt with this pulse, save the pulse time and
192
 
        // clear new_pulse_at, ready for the next pulse
193
 
        last_pulse_at = new_pulse_at;
194
 
        new_pulse_at = 0;
195
 
}
196
 
 
197
 
 
198
 
// wait until it is time to draw the next segment or a new pulse has
199
 
// occurred
200
 
void waitTillEndOfSegment( bool reset )
201
 
{
202
 
        static unsigned long end_time = 0;
203
 
 
204
 
        // handle reset
205
 
        if( reset )
206
 
                end_time = last_pulse_at;
207
 
 
208
 
        // 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;
213
 
                end_time++;
214
 
        }
215
 
 
216
 
        // wait
217
 
        while( micros() < end_time && !new_pulse_at );
218
 
}
219
 
 
220
 
 
221
 
// ISR to handle the pulses from the fan's tachiometer
222
 
void fanPulseHandler()
223
 
{
224
 
        // the fan actually sends two pulses per revolution. These pulses
225
 
        // may not be exactly evenly distributed around the rotation, so
226
 
        // we can't recalculate times on every pulse. Instead, we ignore
227
 
        // every other pulse so timings are based on a complete rotation.
228
 
        static bool ignore = true;
229
 
        ignore = !ignore;
230
 
        if( !ignore )
231
 
        {
232
 
                // set a new pulse time
233
 
                new_pulse_at = micros();
234
 
        }
235
 
}
236
 
 
237
 
 
238
 
// main setup
239
 
void setup()
240
 
{
241
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
242
 
        attachInterrupt( 0, fanPulseHandler, RISING );
243
 
        digitalWrite( 2, HIGH );
244
 
  
245
 
        // set up output pins (4 to 13) for the led array
246
 
        for( int a = 4; a < 14; a++ )
247
 
                pinMode( a, OUTPUT );
248
 
 
249
 
        // set up mode-switch button on pin 3
250
 
        pinMode( 3, INPUT );
251
 
        digitalWrite( 3, HIGH );
252
 
        static int event_times[] = { 5, 500, 4000, 0 };
253
 
        button.set_event_times( event_times );
254
 
 
255
 
        // set up major modes
256
 
        static SwitcherMajorMode switcher_major_mode;
257
 
        int mode = 0;
258
 
        major_modes[ mode++ ] = &switcher_major_mode;
259
 
        major_modes[ 0 ]->activate();
260
 
}
261
 
 
262
 
 
263
 
// main loop
264
 
void loop()
265
 
{
266
 
        // if there has been a new pulse, we'll be resetting the display
267
 
        bool reset = new_pulse_at? true : false;
268
 
 
269
 
        // update button
270
 
        button.update();
271
 
 
272
 
        // only do this stuff at the start of a display cycle, to ensure
273
 
        // that no state changes mid-display
274
 
        if( reset )
275
 
        {
276
 
                // calculate segment times
277
 
                calculateSegmentTimes();
278
 
 
279
 
                // keep track of time
280
 
                Time &time = Time::get_instance();
281
 
                time.update();
282
 
 
283
 
                // perform button events
284
 
                doButtonEvents();
285
 
        }
286
 
 
287
 
        // draw this segment
288
 
        drawNextSegment( reset );
289
 
 
290
 
        // wait till it's time to draw the next segment
291
 
        waitTillEndOfSegment( reset );
292
 
}