/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
59 by edam
removed ulibc, fixed button, added text rendering
78
#include "config.h"
58 by edam
removed Bounce library and updated/fixed new code
79
#include "button.h"
56 by edam
updated software to include drawing abstraction infrastructure
80
#include "time.h"
64 by Tim Marston
added support for eclipse project and converted to a manual Makefile
81
#include "Arduino.h"
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
82
#include "analogue_clock.h"
83
#include "digital_clock.h"
84
#include "test_pattern.h"
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
85
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
86
//_____________________________________________________________________________
87
//                                                                         data
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
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
92
static unsigned long _new_pulse_at = 0;
11 by Dan
added initial propeller clock code
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
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
95
static unsigned long _last_pulse_at = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
96
97
// duration (in microseconds) that a segment should be displayed
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
98
static unsigned long _segment_step = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
99
100
// remainder after divisor and a tally of the remainders for each segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
101
static unsigned long _segment_step_sub_step = 0;
102
static unsigned long _segment_step_sub = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
103
58 by edam
removed Bounce library and updated/fixed new code
104
// the button
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
105
static Button _button( 3 );
106
107
// modes
108
static int _major_mode = 0;
109
static int _minor_mode = 0;
110
111
#define MAIN_MODE_IDX 0
112
113
#define ANALOGUE_CLOCK_IDX 0
114
#define DIGITAL_CLOCK_IDX 1
115
#define TEST_PATTERN_IDX 2
58 by edam
removed Bounce library and updated/fixed new code
116
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
117
//_____________________________________________________________________________
118
//                                                                         code
119
120
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
121
// activate the current minor mode
122
void activate_minor_mode()
123
{
124
	switch( _minor_mode ) {
125
	case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
126
	}
127
}
128
59 by edam
removed ulibc, fixed button, added text rendering
129
// perform button events
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
130
void do_button_events()
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
131
{
59 by edam
removed ulibc, fixed button, added text rendering
132
	// loop through pending events
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
133
	while( int event = _button.get_event() )
59 by edam
removed ulibc, fixed button, added text rendering
134
	{
135
		switch( event )
136
		{
137
		case 1:
138
			// short press
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
139
			switch( _major_mode ) {
140
			case MAIN_MODE_IDX:
141
				switch( _minor_mode ) {
142
				case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
143
				case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
144
				}
145
				break;
146
			}
59 by edam
removed ulibc, fixed button, added text rendering
147
			break;
148
149
		case 2:
150
			// long press
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
151
			switch( _major_mode ) {
152
			case MAIN_MODE_IDX:
153
				if( ++_minor_mode >= 3 )
154
					_minor_mode = 0;
155
				switch( _minor_mode ) {
156
				case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
157
				}
158
				break;
159
			}
59 by edam
removed ulibc, fixed button, added text rendering
160
			break;
161
162
		case 3:
163
			// looooong press (change major mode)
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
164
			if( ++_major_mode > 0 )
165
				_major_mode = 0;
166
			switch( _major_mode ) {
167
			case MAIN_MODE_IDX: _minor_mode = 0; break;
168
			}
169
			activate_minor_mode();
59 by edam
removed ulibc, fixed button, added text rendering
170
			break;
171
		}
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
172
	}
173
}
174
175
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
176
// draw a display segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
177
void draw_next_segment( bool reset )
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
178
{
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
179
	// keep track of segment
180
#if CLOCK_FORWARD
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
181
	static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
182
	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!)
183
#else
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
184
	static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
185
	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!)
186
#endif
187
56 by edam
updated software to include drawing abstraction infrastructure
188
	// draw
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
189
	switch( _major_mode ) {
190
	case MAIN_MODE_IDX:
191
		switch( _minor_mode ) {
192
		case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
193
		case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
194
		case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
195
		}
196
		break;
197
	}
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
198
199
#if CLOCK_FORWARD
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
200
	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!)
201
#else
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
202
	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!)
203
#endif
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
204
}
205
206
207
// calculate time constants when a new pulse has occurred
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
208
void calculate_segment_times()
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
209
{
210
	// check for overflows, and only recalculate times if there isn't
211
	// one (if there is, we'll just go with the last pulse's times)
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
212
	if( _new_pulse_at > _last_pulse_at )
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
213
	{
214
		// new segment stepping times
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
215
		unsigned long delta = _new_pulse_at - _last_pulse_at;
216
		_segment_step = delta / NUM_SEGMENTS;
217
		_segment_step_sub = 0;
218
		_segment_step_sub_step = delta % NUM_SEGMENTS;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
219
	}
220
221
	// now we have dealt with this pulse, save the pulse time and
222
	// clear new_pulse_at, ready for the next pulse
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
223
	_last_pulse_at = _new_pulse_at;
224
	_new_pulse_at = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
225
}
226
227
228
// wait until it is time to draw the next segment or a new pulse has
229
// occurred
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
230
void wait_till_end_of_segment( bool reset )
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
231
{
232
	static unsigned long end_time = 0;
233
234
	// handle reset
235
	if( reset )
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
236
		end_time = _last_pulse_at;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
237
238
	// work out the time that this segment should be displayed until
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
239
	end_time += _segment_step;
240
	_segment_step_sub += _segment_step_sub_step;
241
	if( _segment_step_sub >= NUM_SEGMENTS ) {
242
		_segment_step_sub -= NUM_SEGMENTS;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
243
		end_time++;
244
	}
245
246
	// wait
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
247
	while( micros() < end_time && !_new_pulse_at );
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
248
}
249
250
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
251
// ISR to handle the pulses from the fan's tachiometer
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
252
void fan_pulse_handler()
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
253
{
254
	// the fan actually sends two pulses per revolution. These pulses
255
	// may not be exactly evenly distributed around the rotation, so
256
	// we can't recalculate times on every pulse. Instead, we ignore
257
	// every other pulse so timings are based on a complete rotation.
258
	static bool ignore = true;
259
	ignore = !ignore;
260
	if( !ignore )
261
	{
262
		// set a new pulse time
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
263
		_new_pulse_at = micros();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
264
	}
265
}
266
267
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
268
// main setup
269
void setup()
270
{
271
	// set up an interrupt handler on pin 2 to nitice fan pulses
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
272
	attachInterrupt( 0, fan_pulse_handler, RISING );
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
273
	digitalWrite( 2, HIGH );
274
  
275
	// set up output pins (4 to 13) for the led array
276
	for( int a = 4; a < 14; a++ )
277
		pinMode( a, OUTPUT );
278
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
279
	// set up mode-switch button on pin 3
280
	pinMode( 3, INPUT );
42 by edam
lengthened button debounce time and turned on the pull-up resistor (oops!)
281
	digitalWrite( 3, HIGH );
62 by edam
moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages
282
	static int event_times[] = { 5, 500, 4000, 0 };
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
283
	_button.set_event_times( event_times );
58 by edam
removed Bounce library and updated/fixed new code
284
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
285
	// activate the minor mode
286
	switch( _major_mode ) {
287
	case MAIN_MODE_IDX: activate_minor_mode(); break;
288
	}
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
289
}
290
291
292
// main loop
11 by Dan
added initial propeller clock code
293
void loop()
294
{
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
295
	// if there has been a new pulse, we'll be resetting the display
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
296
	bool reset = _new_pulse_at? true : false;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
297
59 by edam
removed ulibc, fixed button, added text rendering
298
	// update button
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
299
	_button.update();
59 by edam
removed ulibc, fixed button, added text rendering
300
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
301
	// only do this stuff at the start of a display cycle, to ensure
302
	// that no state changes mid-display
303
	if( reset )
304
	{
59 by edam
removed ulibc, fixed button, added text rendering
305
		// calculate segment times
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
306
		calculate_segment_times();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
307
308
		// keep track of time
56 by edam
updated software to include drawing abstraction infrastructure
309
		Time &time = Time::get_instance();
310
		time.update();
59 by edam
removed ulibc, fixed button, added text rendering
311
312
		// perform button events
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
313
		do_button_events();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
314
	}
315
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
316
	// draw this segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
317
	draw_next_segment( reset );
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
318
319
	// wait till it's time to draw the next segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
320
	wait_till_end_of_segment( reset );
11 by Dan
added initial propeller clock code
321
}