1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
5
* Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
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
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.
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.
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/>.
25
/******************************************************************************
29
* a PC fan is wired up to a 12V power supply
31
* the fan's SENSE (tachiometer) pin connected to pin 2 on the
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
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.
42
* a button should be attached to pin 3 that grounds it when pressed.
44
* A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
46
Implementation details:
48
* for a schematic, see ../project/propeller-clock.sch.
50
* the timing of the drawing of the clock face is recalculated with
51
every rotation of the propeller.
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.
61
* pressing the button cycles between variations of the current
64
* pressing and holding the button for a second cycles between display
65
modes (e.g., analogue and digital).
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
76
******************************************************************************/
82
#include "mode_switcher.h"
85
//_____________________________________________________________________________
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
92
static unsigned long new_pulse_at = 0;
94
// the time (in microseconds) when the last fan pulse occurred
95
static unsigned long last_pulse_at = 0;
97
// duration (in microseconds) that a segment should be displayed
98
static unsigned long segment_step = 0;
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;
104
// flag to indicate that the drawing mode should be cycled to the next one
105
static bool inc_draw_mode = false;
107
// a bounce-managed button
108
static Button button( 3 );
110
//_____________________________________________________________________________
114
// check for button presses
118
int event = button.update();
123
inc_draw_mode = true;
129
// turn an led on/off
130
void ledOn( int num, bool on )
132
if( num < 0 || num > 9 ) return;
134
// convert to pin no.
137
// pin 4 needs to be inverted (it's driving a PNP)
138
if( num == 4 ) on = !on;
140
digitalWrite( num, on? HIGH : LOW );
144
// draw a display segment
145
void drawNextSegment( bool reset )
147
static ModeSwitcher mode_switcher;
148
static bool init = false;
152
mode_switcher.activate();
155
// keep track of segment
157
static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
158
if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
160
static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
161
if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
165
Drawer &drawer = mode_switcher.get_drawer();
166
if( reset ) drawer.draw_reset();
167
drawer.draw( segment );
170
if( ++segment >= NUM_SEGMENTS ) segment = 0;
172
if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
177
// calculate time constants when a new pulse has occurred
178
void calculateSegmentTimes()
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 )
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;
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;
198
// wait until it is time to draw the next segment or a new pulse has
200
void waitTillNextSegment( bool reset )
202
static unsigned long end_time = 0;
206
end_time = last_pulse_at;
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;
217
while( micros() < end_time && !new_pulse_at );
221
// ISR to handle the pulses from the fan's tachiometer
222
void fanPulseHandler()
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;
232
// set a new pulse time
233
new_pulse_at = micros();
241
// set up an interrupt handler on pin 2 to nitice fan pulses
242
attachInterrupt( 0, fanPulseHandler, RISING );
243
digitalWrite( 2, HIGH );
245
// set up output pins (4 to 13) for the led array
246
for( int a = 4; a < 14; a++ )
247
pinMode( a, OUTPUT );
249
// set up mode-switch button on pin 3
251
digitalWrite( 3, HIGH );
252
button.add_event_at( 5, 1 );
253
button.add_event_at( 1000, 2 );
254
button.add_event_at( 4000, 3 );
257
Serial.begin( 9600 );
264
// if there has been a new pulse, we'll be resetting the display
265
bool reset = new_pulse_at? true : false;
267
// only do this stuff at the start of a display cycle, to ensure
268
// that no state changes mid-display
274
// keep track of time
275
Time &time = Time::get_instance();
280
drawNextSegment( reset );
282
// do we need to recalculate segment times?
284
calculateSegmentTimes();
286
// wait till it's time to draw the next segment
287
waitTillNextSegment( reset );