/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
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
31
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
32
   Arduino.
23 by edam
renamed code directories and updated the comments in the code
33
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
34
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
23 by edam
renamed code directories and updated the comments in the code
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
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
40
   LEDs that turn on and 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
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
44
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
35 by edam
initialise from real-time clock; updated Makefile
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
    
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
53
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
23 by edam
renamed code directories and updated the comments in the code
54
   software skips every other one. This means that the clock may
55
   appear upside-down if started with the propeller in the wrong
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
56
   position. You will need to experiment to discover the position that
23 by edam
renamed code directories and updated the comments in the code
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"
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
85
#include "settings_mode.h"
86
#include "text.h"
87
#include "text_renderer.h"
88
#include "common.h"
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
89
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
90
//_____________________________________________________________________________
91
//                                                                         data
92
93
// when non-zero, the time (in microseconds) of a new fan pulse that
94
// has just occurred, which means that segment drawing needs to be
95
// restarted
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
96
static unsigned long _new_pulse_at = 0;
11 by Dan
added initial propeller clock code
97
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
98
// the time (in microseconds) when the last fan pulse occurred
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
99
static unsigned long _last_pulse_at = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
100
101
// duration (in microseconds) that a segment should be displayed
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
102
static unsigned long _segment_step = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
103
104
// 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!
105
static unsigned long _segment_step_sub_step = 0;
106
static unsigned long _segment_step_sub = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
107
58 by edam
removed Bounce library and updated/fixed new code
108
// the button
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
109
static Button _button( 3 );
110
111
// modes
112
static int _major_mode = 0;
113
static int _minor_mode = 0;
114
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
115
#define MAIN_MODE_IDX 1
116
#define SETTINGS_MODE_IDX 0
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
117
118
#define ANALOGUE_CLOCK_IDX 0
119
#define DIGITAL_CLOCK_IDX 1
120
#define TEST_PATTERN_IDX 2
58 by edam
removed Bounce library and updated/fixed new code
121
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
122
//_____________________________________________________________________________
123
//                                                                         code
124
125
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
126
// activate the current minor mode
127
void activate_minor_mode()
128
{
74 by Tim Marston
fixed bug initialising text services on mode activation
129
	// reset text
130
	Text::reset();
131
	leds_off();
132
133
	// give the mode a chance to init
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
134
	switch( _minor_mode ) {
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
135
	case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
136
	case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
137
	}
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
138
}
139
140
141
// activate major mode
142
void activate_major_mode()
143
{
74 by Tim Marston
fixed bug initialising text services on mode activation
144
	// reset text
145
	Text::reset();
146
	leds_off();
147
76 by edam
switch button to no interim presses during settings mode; added NVRAM support
148
	// reset buttons
149
	_button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
150
74 by Tim Marston
fixed bug initialising text services on mode activation
151
	// give the mode a chance to init
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
152
	switch( _major_mode ) {
153
	case MAIN_MODE_IDX: activate_minor_mode(); break;
154
	case SETTINGS_MODE_IDX: settings_mode_activate(); break;
155
	}
156
}
157
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
158
59 by edam
removed ulibc, fixed button, added text rendering
159
// perform button events
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
160
void do_button_events()
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
161
{
59 by edam
removed ulibc, fixed button, added text rendering
162
	// loop through pending events
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
163
	while( int event = _button.get_event() )
59 by edam
removed ulibc, fixed button, added text rendering
164
	{
165
		switch( event )
166
		{
167
		case 1:
168
			// short press
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
169
			switch( _major_mode ) {
170
			case MAIN_MODE_IDX:
171
				switch( _minor_mode ) {
172
				case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
173
				case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
174
				}
175
				break;
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
176
			case SETTINGS_MODE_IDX: settings_mode_press(); break;
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
177
			}
59 by edam
removed ulibc, fixed button, added text rendering
178
			break;
179
180
		case 2:
181
			// long press
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
182
			switch( _major_mode ) {
183
			case MAIN_MODE_IDX:
184
				if( ++_minor_mode >= 3 )
185
					_minor_mode = 0;
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
186
				activate_minor_mode();
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
187
				break;
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
188
			case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
189
			}
59 by edam
removed ulibc, fixed button, added text rendering
190
			break;
191
192
		case 3:
193
			// looooong press (change major mode)
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
194
			if( ++_major_mode > 1 )
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
195
				_major_mode = 0;
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
196
			activate_major_mode();
59 by edam
removed ulibc, fixed button, added text rendering
197
			break;
198
		}
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
199
	}
200
}
201
202
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
203
// draw a display segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
204
void draw_next_segment( bool reset )
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
205
{
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
206
	// keep track of segment
207
#if CLOCK_FORWARD
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
208
	static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
209
	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!)
210
#else
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
211
	static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
212
	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!)
213
#endif
214
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
215
	// reset the text renderer
216
	TextRenderer::reset_buffer();
217
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
218
	// frame reset
219
	if( reset ) {
220
		switch( _major_mode ) {
221
		case MAIN_MODE_IDX:
222
			switch( _minor_mode ) {
223
			case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
224
			case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
225
			}
226
			break;
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
227
		case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
228
		}
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
229
230
		// tell the text services we're starting a new frame
231
		Text::draw_reset();
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
232
	}
233
56 by edam
updated software to include drawing abstraction infrastructure
234
	// draw
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
235
	switch( _major_mode ) {
236
	case MAIN_MODE_IDX:
237
		switch( _minor_mode ) {
238
		case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
239
		case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
240
		case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
241
		}
242
		break;
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
243
	case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
244
	}
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
245
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
246
	// draw any text that was rendered
247
	TextRenderer::output_buffer();
248
53 by edam
conrtol segment number from one place and reverse the order the segments are drawn (backwards clock!)
249
#if CLOCK_FORWARD
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
250
	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!)
251
#else
54 by edam
changed 12-tick to a double tick, added CLOCK_SHIFT to align face and fixed hour-hand
252
	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!)
253
#endif
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
254
}
255
256
257
// calculate time constants when a new pulse has occurred
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
258
void calculate_segment_times()
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
259
{
260
	// check for overflows, and only recalculate times if there isn't
261
	// 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!
262
	if( _new_pulse_at > _last_pulse_at )
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
263
	{
264
		// new segment stepping times
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
265
		unsigned long delta = _new_pulse_at - _last_pulse_at;
266
		_segment_step = delta / NUM_SEGMENTS;
267
		_segment_step_sub = 0;
268
		_segment_step_sub_step = delta % NUM_SEGMENTS;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
269
	}
270
271
	// now we have dealt with this pulse, save the pulse time and
272
	// clear new_pulse_at, ready for the next pulse
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
273
	_last_pulse_at = _new_pulse_at;
274
	_new_pulse_at = 0;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
275
}
276
277
278
// wait until it is time to draw the next segment or a new pulse has
279
// occurred
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
280
void wait_till_end_of_segment( bool reset )
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
281
{
282
	static unsigned long end_time = 0;
283
284
	// handle reset
285
	if( reset )
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
286
		end_time = _last_pulse_at;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
287
288
	// work out the time that this segment should be displayed until
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
289
	end_time += _segment_step;
290
	_segment_step_sub += _segment_step_sub_step;
291
	if( _segment_step_sub >= NUM_SEGMENTS ) {
292
		_segment_step_sub -= NUM_SEGMENTS;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
293
		end_time++;
294
	}
295
296
	// wait
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
297
	while( micros() < end_time && !_new_pulse_at );
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
298
}
299
300
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
301
// ISR to handle the pulses from the fan's tachiometer
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
302
void fan_pulse_handler()
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
303
{
304
	// the fan actually sends two pulses per revolution. These pulses
305
	// may not be exactly evenly distributed around the rotation, so
306
	// we can't recalculate times on every pulse. Instead, we ignore
307
	// every other pulse so timings are based on a complete rotation.
308
	static bool ignore = true;
309
	ignore = !ignore;
310
	if( !ignore )
311
	{
312
		// set a new pulse time
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
313
		_new_pulse_at = micros();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
314
	}
315
}
316
317
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
318
// main setup
319
void setup()
320
{
321
	// 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!
322
	attachInterrupt( 0, fan_pulse_handler, RISING );
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
323
	digitalWrite( 2, HIGH );
324
  
325
	// set up output pins (4 to 13) for the led array
326
	for( int a = 4; a < 14; a++ )
327
		pinMode( a, OUTPUT );
328
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
329
	// set up mode-switch button on pin 3
330
	pinMode( 3, INPUT );
42 by edam
lengthened button debounce time and turned on the pull-up resistor (oops!)
331
	digitalWrite( 3, HIGH );
62 by edam
moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages
332
	static int event_times[] = { 5, 500, 4000, 0 };
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
333
	_button.set_event_times( event_times );
58 by edam
removed Bounce library and updated/fixed new code
334
68 by Tim Marston
added frame reset code and inited minor mode flavours on mode activation
335
	// initialise RTC
66 by Tim Marston
removed time singleton, not cause it saved much space, but cause i don't want singletons in this project!
336
	Time::init();
337
76 by edam
switch button to no interim presses during settings mode; added NVRAM support
338
	// init text renderer
339
	TextRenderer::init();
340
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
341
	// activate the minor mode
71 by Tim Marston
added time set mode, made text renderer's buffer auto reset/output
342
	activate_major_mode();
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
343
}
344
345
346
// main loop
11 by Dan
added initial propeller clock code
347
void loop()
348
{
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
349
	// 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!
350
	bool reset = _new_pulse_at? true : false;
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
351
59 by edam
removed ulibc, fixed button, added text rendering
352
	// update button
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
353
	_button.update();
59 by edam
removed ulibc, fixed button, added text rendering
354
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
355
	// only do this stuff at the start of a display cycle, to ensure
356
	// that no state changes mid-display
357
	if( reset )
358
	{
59 by edam
removed ulibc, fixed button, added text rendering
359
		// calculate segment times
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
360
		calculate_segment_times();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
361
362
		// keep track of time
66 by Tim Marston
removed time singleton, not cause it saved much space, but cause i don't want singletons in this project!
363
		Time::update();
59 by edam
removed ulibc, fixed button, added text rendering
364
365
		// perform button events
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
366
		do_button_events();
16 by edam
finished first revision of propeller-clock code (can display clock and test); added Bounce library
367
	}
368
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
369
	// draw this segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
370
	draw_next_segment( reset );
13 by edam
updated propeller-clock code, added GPL text and renamed fan-test
371
372
	// wait till it's time to draw the next segment
65 by Tim Marston
removed most OOP/inheritance crap, saved loads of space!
373
	wait_till_end_of_segment( reset );
11 by Dan
added initial propeller clock code
374
}