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
******************************************************************************/
81
#include "mode_switcher.h"
84
//_____________________________________________________________________________
88
// when non-zero, the time (in microseconds) of a new fan pulse that
89
// has just occurred, which means that segment drawing needs to be
91
static unsigned long new_pulse_at = 0;
93
// the time (in microseconds) when the last fan pulse occurred
94
static unsigned long last_pulse_at = 0;
96
// duration (in microseconds) that a segment should be displayed
97
static unsigned long segment_step = 0;
99
// remainder after divisor and a tally of the remainders for each segment
100
static unsigned long segment_step_sub_step = 0;
101
static unsigned long segment_step_sub = 0;
104
static Button button( 3 );
107
static int major_mode = 0;
110
static std::vector< MajorMode * > major_modes;
112
//_____________________________________________________________________________
116
// check for button presses
120
int event = button.update();
125
major_modes[ major_mode ]->short_press();
128
major_modes[ major_mode ]->long_press();
131
if( ++major_mode >= major_modes.size() )
133
major_modes[ major_mode ]->activate();
139
// draw a display segment
140
void drawNextSegment( bool reset )
142
// keep track of segment
144
static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
145
if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
147
static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
148
if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
152
Drawer &drawer = major_modes[ major_mode ]->get_drawer();
153
if( reset ) drawer.draw_reset();
154
drawer.draw( segment );
157
if( ++segment >= NUM_SEGMENTS ) segment = 0;
159
if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
164
// calculate time constants when a new pulse has occurred
165
void calculateSegmentTimes()
167
// check for overflows, and only recalculate times if there isn't
168
// one (if there is, we'll just go with the last pulse's times)
169
if( new_pulse_at > last_pulse_at )
171
// new segment stepping times
172
unsigned long delta = new_pulse_at - last_pulse_at;
173
segment_step = delta / NUM_SEGMENTS;
174
segment_step_sub = 0;
175
segment_step_sub_step = delta % NUM_SEGMENTS;
178
// now we have dealt with this pulse, save the pulse time and
179
// clear new_pulse_at, ready for the next pulse
180
last_pulse_at = new_pulse_at;
185
// wait until it is time to draw the next segment or a new pulse has
187
void waitTillNextSegment( bool reset )
189
static unsigned long end_time = 0;
193
end_time = last_pulse_at;
195
// work out the time that this segment should be displayed until
196
end_time += segment_step;
197
segment_step_sub += segment_step_sub_step;
198
if( segment_step_sub >= NUM_SEGMENTS ) {
199
segment_step_sub -= NUM_SEGMENTS;
204
while( micros() < end_time && !new_pulse_at );
208
// ISR to handle the pulses from the fan's tachiometer
209
void fanPulseHandler()
211
// the fan actually sends two pulses per revolution. These pulses
212
// may not be exactly evenly distributed around the rotation, so
213
// we can't recalculate times on every pulse. Instead, we ignore
214
// every other pulse so timings are based on a complete rotation.
215
static bool ignore = true;
219
// set a new pulse time
220
new_pulse_at = micros();
228
// set up an interrupt handler on pin 2 to nitice fan pulses
229
attachInterrupt( 0, fanPulseHandler, RISING );
230
digitalWrite( 2, HIGH );
232
// set up output pins (4 to 13) for the led array
233
for( int a = 4; a < 14; a++ )
234
pinMode( a, OUTPUT );
236
// set up mode-switch button on pin 3
238
digitalWrite( 3, HIGH );
239
button.add_event_at( 5, 1 );
240
button.add_event_at( 1000, 2 );
241
button.add_event_at( 4000, 3 );
244
Serial.begin( 9600 );
246
// set up major modes
247
static ModeSwitcher mode_switcher;
248
major_modes.push_back( &mode_switcher );
249
major_modes[ 0 ]->activate();
256
// if there has been a new pulse, we'll be resetting the display
257
bool reset = new_pulse_at? true : false;
259
// only do this stuff at the start of a display cycle, to ensure
260
// that no state changes mid-display
266
// keep track of time
267
Time &time = Time::get_instance();
272
drawNextSegment( reset );
274
// do we need to recalculate segment times?
276
calculateSegmentTimes();
278
// wait till it's time to draw the next segment
279
waitTillNextSegment( reset );