To get this branch, use:
bzr branch
http://bzr.ed.am/elec/propeller-clock
« back to all changes in this revision
Viewing changes to src/propeller-clock.cc
- browse files at revision 77
- compare with another revision
- download diff
- download tarball
- view history from revision 77
- Committer: Tim Marston
- Date: 2012-04-29 15:26:03 UTC
- Revision ID: tim@ed.am-20120429152603-yoj8oi7wlzb0qwnx
added a 5V power regulator to schematic (since the one on our arduino was crap)
- files added:
- arduino.mk
- project
- test/fan-test
- test/fan-test/Makefile
- test/led-test
- test/led-test/Makefile
- test/phantom-button-presses
- test/phantom-button-presses/Makefile
- test/rtc-test
- test/rtc-test/util
- files removed:
- COPYING
- files renamed:
- Notes => notes
- propeller-clock/ => src/
- propeller-clock/propeller-clock.pde => src/propeller-clock.cc
- propeller-clock/utility/ => src/util/
- fan-test/ => test/
- fan-test/fan-test.pde => test/fan-test/fan-test.ino
- files modified:
- .bzrignore
added
removed
src/propeller-clock.cc
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
1
2
/*
2
* propeller-clock.pde
3
* propeller-clock.ino
3
4
*
4
* Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
5
* Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
6
*
6
7
* This file is part of propeller-clock (hereafter referred to as "this
7
* program"). See http://ed.am/software/arduino/propeller-clock for more
8
* program"). See http://ed.am/dev/software/arduino/propeller-clock for more
8
9
* information.
9
10
*
10
11
* This program is free software: you can redistribute it and/or modify
23
24
24
25
/******************************************************************************
25
26
26
For a schematic, see propeller-clock.sch.
27
28
Set up as follows:
29
30
- a PC fan is wired up to the 12V supply.
31
32
- the fan's SENSE (tachiometer) pin is connected to pin 2 on the
33
arduino.
34
35
- the pins 4 to 13 on the arduino should directly drive an LED (the
36
LED on pin 4 is in the centre of the clock face and the LED on pin
37
13 is at the outside.
38
39
- if a longer hand (and a larger clock face) is desired, pin 4 can
40
be used to indirectly drive (via a MOSFET) multiple LEDs which
41
turn on and off in unison in the centre of the clock.
42
43
- a button should be attached to pin 3 that grounds it when pressed.
44
45
Implementation details:
46
47
- the timing of the drawing of the clock face is recalculated with
48
every rotation of the propeller (for maximum update speed).
49
50
- pressing the button cycles between display modes
51
52
- holding down the button for 2 seconds enters "set time" mode. In
53
this mode, the fan must be held still and the LEDs will indicate
54
what number is being entered for each time digit. Pressing the
55
button increments the current digit. Holding it down moves to the
56
next digit (or leaves "set time" mode when there are no more). In
57
order, the digits (with accepted values) are: hours-tens (0 to 2),
58
hours-ones (0 to 9), minutes-tens (0 to 5), minutes-ones (0 to 9).
27
Set up:
28
29
* a PC fan is wired up to a 12V power supply
30
31
* the fan's SENSE (tachometer) 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
39
used to indirectly drive a transistor which in turn drives several
40
LEDs that turn on and off in unison in the centre of the clock.
41
42
* a button should be attached to pin 3 that grounds it when pressed.
43
44
* A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
45
46
Implementation details:
47
48
* for a schematic, see ../project/propeller-clock.sch.
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 tachometer 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 discover 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
73
- pressing and holding the button for 5 seconds sets the time and
74
exits "time set" mode
59
75
60
76
******************************************************************************/
61
77
62
63
#include <Bounce.h>
78
#include "config.h"
79
#include "button.h"
80
#include "time.h"
81
#include "Arduino.h"
82
#include "analogue_clock.h"
83
#include "digital_clock.h"
84
#include "test_pattern.h"
85
#include "settings_mode.h"
86
#include "text.h"
87
#include "text_renderer.h"
88
#include "common.h"
64
89
65
90
//_____________________________________________________________________________
66
91
// data
67
92
68
69
93
// when non-zero, the time (in microseconds) of a new fan pulse that
70
94
// has just occurred, which means that segment drawing needs to be
71
95
// restarted
72
static unsigned long new_pulse_at = 0;
96
static unsigned long _new_pulse_at = 0;
73
97
74
98
// the time (in microseconds) when the last fan pulse occurred
75
static unsigned long last_pulse_at = 0;
99
static unsigned long _last_pulse_at = 0;
76
100
77
101
// duration (in microseconds) that a segment should be displayed
78
static unsigned long segment_step = 0;
102
static unsigned long _segment_step = 0;
79
103
80
104
// remainder after divisor and a tally of the remainders for each segment
81
static unsigned long segment_step_sub_step = 0;
82
static unsigned long segment_step_sub = 0;
83
84
// flag to indicate that the drawing mode should be cycled to the next one
85
static bool inc_draw_mode = false;
86
87
// a bounce-managed button
88
static Bounce button( 3, 5 );
89
90
// the time
91
static int time_hours = 0;
92
static int time_minutes = 0;
93
static int time_seconds = 0;
94
95
// number of segments in a full display (rotation) is 60 (one per
96
// second) times the desired number of sub-divisions of a second
97
#define NUM_SECOND_SEGMENTS 5
98
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
105
static unsigned long _segment_step_sub_step = 0;
106
static unsigned long _segment_step_sub = 0;
107
108
// the button
109
static Button _button( 3 );
110
111
// modes
112
static int _major_mode = 0;
113
static int _minor_mode = 0;
114
115
#define MAIN_MODE_IDX 1
116
#define SETTINGS_MODE_IDX 0
117
118
#define ANALOGUE_CLOCK_IDX 0
119
#define DIGITAL_CLOCK_IDX 1
120
#define TEST_PATTERN_IDX 2
99
121
100
122
//_____________________________________________________________________________
101
123
// code
102
124
103
125
104
// check for button presses
105
void checkButtons()
106
{
107
// update buttons
108
button.update();
109
110
// notice button presses
111
if( button.risingEdge() )
112
inc_draw_mode = true;
113
}
114
115
116
// keep track of time
117
void trackTime()
118
{
119
// previous time and any carried-over milliseconds
120
static unsigned long last_time = millis();
121
static unsigned long carry = 0;
122
123
// how many milliseonds have elapsed since we last checked?
124
unsigned long next_time = millis();
125
unsigned long delta = next_time - last_time + carry;
126
127
// update the previous time and carried-over milliseconds
128
last_time = next_time;
129
carry = delta % 1000;
130
131
// add the seconds that have passed to the time
132
time_seconds += delta / 1000;
133
while( time_seconds >= 60 ) {
134
time_seconds -= 60;
135
time_minutes++;
136
if( time_minutes >= 60 ) {
137
time_minutes -= 60;
138
time_hours++;
139
if( time_hours >= 24 )
140
time_hours -= 24;
126
// activate the current minor mode
127
void activate_minor_mode()
128
{
129
// reset text
130
Text::reset();
131
leds_off();
132
133
// give the mode a chance to init
134
switch( _minor_mode ) {
135
case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
136
case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
137
}
138
}
139
140
141
// activate major mode
142
void activate_major_mode()
143
{
144
// reset text
145
Text::reset();
146
leds_off();
147
148
// reset buttons
149
_button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
150
151
// give the mode a chance to init
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
158
159
// perform button events
160
void do_button_events()
161
{
162
// loop through pending events
163
while( int event = _button.get_event() )
164
{
165
switch( event )
166
{
167
case 1:
168
// short press
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;
176
case SETTINGS_MODE_IDX: settings_mode_press(); break;
177
}
178
break;
179
180
case 2:
181
// long press
182
switch( _major_mode ) {
183
case MAIN_MODE_IDX:
184
if( ++_minor_mode >= 3 )
185
_minor_mode = 0;
186
activate_minor_mode();
187
break;
188
case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
189
}
190
break;
191
192
case 3:
193
// looooong press (change major mode)
194
if( ++_major_mode > 1 )
195
_major_mode = 0;
196
activate_major_mode();
197
break;
141
198
}
142
199
}
143
200
}
144
201
145
202
146
// draw a segment for the test display
147
void drawNextSegment_test( bool reset )
203
// draw a display segment
204
void draw_next_segment( bool reset )
148
205
{
149
206
// keep track of segment
150
static unsigned int segment = 0;
151
if( reset ) segment = 0;
152
segment++;
153
154
// turn on inside and outside LEDs
155
digitalWrite( 4, HIGH );
156
digitalWrite( 13, HIGH );
157
158
// display segment number in binary across in the inside LEDs,
159
// with the LED on pin 12 showing the least-significant bit
160
for( int a = 0; a < 8; a++ )
161
digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
162
}
163
164
165
// draw a segment for the time display
166
void drawNextSegment_time( bool reset )
167
{
168
static unsigned int second = 0;
169
static unsigned int segment = 0;
170
171
// handle display reset
207
#if CLOCK_FORWARD
208
static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
209
if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
210
#else
211
static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
212
if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
213
#endif
214
215
// reset the text renderer
216
TextRenderer::reset_buffer();
217
218
// frame reset
172
219
if( reset ) {
173
second = 0;
174
segment = 0;
175
}
176
177
// what needs to be drawn?
178
bool draw_tick = !segment && second % 5 == 0;
179
bool draw_second = !segment && second == time_seconds;
180
bool draw_minute = !segment && second == time_minute;
181
bool draw_hour = !segment && second == time_hour;
182
183
// set the LEDs
184
digitalWrite( 13, HIGH );
185
digitalWrite( 12, draw_tick || draw_minute );
186
for( int a = 10; a <= 11; a++ )
187
digitalWrite( a, draw_minute || draw_second );
188
for( int a = 4; a <= 9; a++ )
189
digitalWrite( 10, draw_minute | draw_second || draw_hour );
190
191
// inc position
192
if( ++segment >= NUM_SECOND_SEGMENTS ) {
193
segment = 0;
194
second++;
195
}
196
}
197
198
199
// draw a display segment
200
void drawNextSegment( bool reset )
201
{
202
static int draw_mode = 0;
203
204
// handle mode switch requests
205
if( reset && inc_draw_mode ) {
206
inc_draw_mode = false;
207
draw_mode++;
208
if( draw_mode >= 2 )
209
draw_mode = 0;
210
}
211
212
// draw the segment
213
switch( draw_mode ) {
214
case 0: drawNextSegment_test( reset ); break;
215
case 1: drawNextSegment_time( reset ); break;
216
}
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;
227
case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
228
}
229
230
// tell the text services we're starting a new frame
231
Text::draw_reset();
232
}
233
234
// draw
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;
243
case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
244
}
245
246
// draw any text that was rendered
247
TextRenderer::output_buffer();
248
249
#if CLOCK_FORWARD
250
if( ++segment >= NUM_SEGMENTS ) segment = 0;
251
#else
252
if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
253
#endif
217
254
}
218
255
219
256
220
257
// calculate time constants when a new pulse has occurred
221
void calculateSegmentTimes()
258
void calculate_segment_times()
222
259
{
223
260
// check for overflows, and only recalculate times if there isn't
224
261
// one (if there is, we'll just go with the last pulse's times)
225
if( new_pulse_at > last_pulse_at )
262
if( _new_pulse_at > _last_pulse_at )
226
263
{
227
264
// new segment stepping times
228
unsigned long delta = new_pulse_at - last_pulse_at;
229
segment_step = delta / NUM_SEGMENTS;
230
segment_step_sub = 0;
231
segment_step_sub_step = delta % NUM_SEGMENTS;
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;
232
269
}
233
270
234
271
// now we have dealt with this pulse, save the pulse time and
235
272
// clear new_pulse_at, ready for the next pulse
236
last_pulse_at = new_pulse_at;
237
new_pulse_at = 0;
273
_last_pulse_at = _new_pulse_at;
274
_new_pulse_at = 0;
238
275
}
239
276
240
277
241
278
// wait until it is time to draw the next segment or a new pulse has
242
279
// occurred
243
void waitTillNextSegment( bool reset )
280
void wait_till_end_of_segment( bool reset )
244
281
{
245
282
static unsigned long end_time = 0;
246
283
247
284
// handle reset
248
285
if( reset )
249
end_time = last_pulse_at;
286
end_time = _last_pulse_at;
250
287
251
288
// work out the time that this segment should be displayed until
252
end_time += segment_step;
253
segment_step_sub += segment_step_sub_step;
254
if( segment_step_sub >= NUM_SEGMENTS ) {
255
segment_step_sub -= NUM_SEGMENTS;
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;
256
293
end_time++;
257
294
}
258
295
259
296
// wait
260
while( micros() < end_time && !new_pulse_at );
297
while( micros() < end_time && !_new_pulse_at );
261
298
}
262
299
263
300
264
301
// ISR to handle the pulses from the fan's tachiometer
265
void fanPulseHandler()
302
void fan_pulse_handler()
266
303
{
267
304
// the fan actually sends two pulses per revolution. These pulses
268
305
// may not be exactly evenly distributed around the rotation, so
273
310
if( !ignore )
274
311
{
275
312
// set a new pulse time
276
new_pulse_at = micros();
313
_new_pulse_at = micros();
277
314
}
278
315
}
279
316
282
319
void setup()
283
320
{
284
321
// set up an interrupt handler on pin 2 to nitice fan pulses
285
attachInterrupt( 0, fanPulseHandler, RISING );
322
attachInterrupt( 0, fan_pulse_handler, RISING );
286
323
digitalWrite( 2, HIGH );
287
324
288
325
// set up output pins (4 to 13) for the led array
291
328
292
329
// set up mode-switch button on pin 3
293
330
pinMode( 3, INPUT );
294
295
// serial comms
296
Serial.begin( 9600 );
331
digitalWrite( 3, HIGH );
332
static int event_times[] = { 5, 500, 4000, 0 };
333
_button.set_event_times( event_times );
334
335
// initialise RTC
336
Time::init();
337
338
// init text renderer
339
TextRenderer::init();
340
341
// activate the minor mode
342
activate_major_mode();
297
343
}
298
344
299
345
301
347
void loop()
302
348
{
303
349
// if there has been a new pulse, we'll be resetting the display
304
bool reset = new_pulse_at? true : false;
350
bool reset = _new_pulse_at? true : false;
351
352
// update button
353
_button.update();
305
354
306
355
// only do this stuff at the start of a display cycle, to ensure
307
356
// that no state changes mid-display
308
357
if( reset )
309
358
{
310
// check buttons
311
checkButtons();
359
// calculate segment times
360
calculate_segment_times();
312
361
313
362
// keep track of time
314
trackTime();
363
Time::update();
364
365
// perform button events
366
do_button_events();
315
367
}
316
368
317
369
// draw this segment
318
drawNextSegment( reset );
319
320
// do we need to recalculate segment times?
321
if( reset )
322
calculateSegmentTimes();
370
draw_next_segment( reset );
323
371
324
372
// wait till it's time to draw the next segment
325
waitTillNextSegment( reset );
373
wait_till_end_of_segment( reset );
326
374
}
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0