/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock
43 by edam
added phantom button press test and temporarily disabled pin 4 (that drives the PNP transistor)
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
2
/*
27 by edam
updated propeller clock code for arduino-1.0 and fixed a compiler error
3
 * propeller-clock.ino
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
4
 *
27 by edam
updated propeller clock code for arduino-1.0 and fixed a compiler error
5
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
6
 *
7
 * This file is part of propeller-clock (hereafter referred to as "this
29 by edam
corrected URL and removed scematic from src
8
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
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
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
25
/******************************************************************************
26
23 by edam
renamed code directories and updated the comments in the code
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
35 by edam
initialise from real-time clock; updated Makefile
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.
23 by edam
renamed code directories and updated the comments in the code
41
42
 * a button should be attached to pin 3 that grounds it when pressed.
43
35 by edam
initialise from real-time clock; updated Makefile
44
 * A DS1307 remote clock is connected via I2C on analog pins 4 and 5.
45
23 by edam
renamed code directories and updated the comments in the code
46
Implementation details:
47
35 by edam
initialise from real-time clock; updated Makefile
48
 * for a schematic, see ../project/propeller-clock.sch.
23 by edam
renamed code directories and updated the comments in the code
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
35 by edam
initialise from real-time clock; updated Makefile
73
    - pressing and holding the button for 5 seconds sets the time and
74
      exits "time set" mode
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
75
76
******************************************************************************/
77
78
56 by edam
updated software to include drawing abstraction infrastructure
79
#include <button.h>
80
#include "config.h"
81
#include "time.h"
82
#include "mode_switcher.h"
83
#include "drawer.h"
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
84
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
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
11 by Dan
added initial propeller clock code
92
static unsigned long new_pulse_at = 0;
93
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
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
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
104
// flag to indicate that the drawing mode should be cycled to the next one
105
static bool inc_draw_mode = false;
106
107
// a bounce-managed button
56 by edam
updated software to include drawing abstraction infrastructure
108
static Button button( 3 );
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
109
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
110
//_____________________________________________________________________________
111
//                                                                         code
112
113
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
114
// check for button presses
115
void checkButtons()
116
{
117
	// update buttons
56 by edam
updated software to include drawing abstraction infrastructure
118
	int event = button.update();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
119
56 by edam
updated software to include drawing abstraction infrastructure
120
	// handle any events
121
	switch( event ) {
122
	case 1:
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
123
		inc_draw_mode = true;
56 by edam
updated software to include drawing abstraction infrastructure
124
		break;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
125
	}
126
}
127
128
38 by edam
abstracted turning leds on/off to cope with PNP-inverted pin 4 and fixed warnings
129
// turn an led on/off
130
void ledOn( int num, bool on )
131
{
132
	if( num < 0 || num > 9 ) return;
133
134
	// convert to pin no.
135
	num += 4;
136
137
	// pin 4 needs to be inverted (it's driving a PNP)
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
138
	if( num == 4 ) on = !on;
38 by edam
abstracted turning leds on/off to cope with PNP-inverted pin 4 and fixed warnings
139
140
	digitalWrite( num, on? HIGH : LOW );
141
}
142
143
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
144
// draw a display segment
145
void drawNextSegment( bool reset )
146
{
56 by edam
updated software to include drawing abstraction infrastructure
147
	static ModeSwitcher mode_switcher;
148
	static bool init = false;
149
150
	if( !init ) {
151
		init = true;
152
		mode_switcher.activate();
153
	}
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
154
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
155
	// keep track of segment
156
#if CLOCK_FORWARD
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
157
	static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
158
	if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
159
#else
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
160
	static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
161
	if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
162
#endif
163
56 by edam
updated software to include drawing abstraction infrastructure
164
	// draw
165
	Drawer &drawer = mode_switcher.get_drawer();
166
	if( reset ) drawer.draw_reset();
167
	drawer.draw( segment );
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
168
169
#if CLOCK_FORWARD
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
170
	if( ++segment >= NUM_SEGMENTS ) segment = 0;
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
171
#else
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
172
	if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
173
#endif
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
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 waitTillNextSegment( 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;
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
210
	segment_step_sub += segment_step_sub_step;
211
	if( segment_step_sub >= NUM_SEGMENTS ) {
212
		segment_step_sub -= NUM_SEGMENTS;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
213
		end_time++;
214
	}
215
216
	// wait
217
	while( micros() < end_time && !new_pulse_at );
218
}
219
220
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
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
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
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
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
249
	// set up mode-switch button on pin 3
250
	pinMode( 3, INPUT );
42 by edam
lengthened button debounce time and turned on the pull-up resistor (oops!)
251
	digitalWrite( 3, HIGH );
56 by edam
updated software to include drawing abstraction infrastructure
252
	button.add_event_at( 5, 1 );
253
	button.add_event_at( 1000, 2 );
254
	button.add_event_at( 4000, 3 );
35 by edam
initialise from real-time clock; updated Makefile
255
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
256
	// serial comms
257
	Serial.begin( 9600 );
258
}
259
260
261
// main loop
11 by Dan
added initial propeller clock code
262
void loop()
263
{
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
264
	// if there has been a new pulse, we'll be resetting the display
265
	bool reset = new_pulse_at? true : false;
266
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
267
	// only do this stuff at the start of a display cycle, to ensure
268
	// that no state changes mid-display
269
	if( reset )
270
	{
271
		// check buttons
272
		checkButtons();
273
274
		// keep track of time
56 by edam
updated software to include drawing abstraction infrastructure
275
		Time &time = Time::get_instance();
276
		time.update();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
277
	}
278
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
279
	// draw this segment
280
	drawNextSegment( reset );
281
282
	// do we need to recalculate segment times?
283
	if( reset )
284
		calculateSegmentTimes();
285
286
	// wait till it's time to draw the next segment
287
	waitTillNextSegment( reset );
11 by Dan
added initial propeller clock code
288
}