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 83
- compare with another revision
- download diff
- download tarball
- view history from revision 83
- Committer: Tim Marston
- Date: 2012-05-17 19:17:05 UTC
- Revision ID: tim@ed.am-20120517191705-3d28d50tw8w51v7g
removed 5V regulator from scematic and replaced the connection to the regulator
on the Arduino -- ecause that's what we should be using and out seperate
regulator is only working around a fault in out arduino
on the Arduino -- ecause that's what we should be using and out seperate
regulator is only working around a fault in out arduino
- files added:
- arduino.mk
- project
- src/modes
- 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/Makefile
- 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 "modes/analogue_clock.h"
83
#include "modes/digital_clock.h"
84
#include "modes/test_pattern.h"
85
#include "modes/settings_mode.h"
86
#include "modes/info_mode.h"
87
#include "text.h"
88
#include "text_renderer.h"
89
#include "common.h"
64
90
65
91
//_____________________________________________________________________________
66
92
// data
67
93
68
69
94
// when non-zero, the time (in microseconds) of a new fan pulse that
70
95
// has just occurred, which means that segment drawing needs to be
71
96
// restarted
72
static unsigned long new_pulse_at = 0;
97
static unsigned long _new_pulse_at = 0;
73
98
74
99
// the time (in microseconds) when the last fan pulse occurred
75
static unsigned long last_pulse_at = 0;
100
static unsigned long _last_pulse_at = 0;
76
101
77
102
// duration (in microseconds) that a segment should be displayed
78
static unsigned long segment_step = 0;
103
static unsigned long _segment_step = 0;
79
104
80
105
// 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 )
106
static unsigned long _segment_step_sub_step = 0;
107
static unsigned long _segment_step_sub = 0;
108
109
// the button
110
static Button _button( 3 );
111
112
// modes
113
static int _major_mode = 0;
114
static int _minor_mode = 0;
115
116
#define MAIN_MODE_IDX 1
117
#define SETTINGS_MODE_IDX 0
118
119
#define ANALOGUE_CLOCK_IDX 0
120
#define DIGITAL_CLOCK_IDX 1
121
#define TEST_PATTERN_IDX 2
122
#define INFO_MODE_IDX 3
99
123
100
124
//_____________________________________________________________________________
101
125
// code
102
126
103
127
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;
128
// activate the current minor mode
129
void activate_minor_mode()
130
{
131
// reset text
132
Text::reset();
133
leds_off();
134
135
// give the mode a chance to init
136
switch( _minor_mode ) {
137
case ANALOGUE_CLOCK_IDX: analogue_clock_activate(); break;
138
case DIGITAL_CLOCK_IDX: digital_clock_activate(); break;
139
case INFO_MODE_IDX: info_mode_activate(); break;
140
}
141
}
142
143
144
// activate major mode
145
void activate_major_mode()
146
{
147
// reset text
148
Text::reset();
149
leds_off();
150
151
// reset buttons
152
_button.set_press_mode( _major_mode != SETTINGS_MODE_IDX );
153
154
// give the mode a chance to init
155
switch( _major_mode ) {
156
case MAIN_MODE_IDX: activate_minor_mode(); break;
157
case SETTINGS_MODE_IDX: settings_mode_activate(); break;
158
}
159
}
160
161
162
// perform button events
163
void do_button_events()
164
{
165
// loop through pending events
166
while( int event = _button.get_event() )
167
{
168
switch( event )
169
{
170
case 1:
171
// short press
172
switch( _major_mode ) {
173
case MAIN_MODE_IDX:
174
switch( _minor_mode ) {
175
case ANALOGUE_CLOCK_IDX: analogue_clock_press(); break;
176
case DIGITAL_CLOCK_IDX: digital_clock_press(); break;
177
case INFO_MODE_IDX: info_mode_press(); break;
178
}
179
break;
180
case SETTINGS_MODE_IDX: settings_mode_press(); break;
181
}
182
break;
183
184
case 2:
185
// long press
186
switch( _major_mode ) {
187
case MAIN_MODE_IDX:
188
if( ++_minor_mode >= 3 )
189
_minor_mode = 0;
190
activate_minor_mode();
191
break;
192
case SETTINGS_MODE_IDX: settings_mode_long_press(); break;
193
}
194
break;
195
196
case 3:
197
// looooong press (change major mode)
198
if( ++_major_mode > 1 )
199
_major_mode = 0;
200
activate_major_mode();
201
break;
141
202
}
142
203
}
143
204
}
144
205
145
206
146
// draw a segment for the test display
147
void drawNextSegment_test( bool reset )
207
// draw a display segment
208
void draw_next_segment( bool reset )
148
209
{
149
210
// 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
211
#if CLOCK_FORWARD
212
static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
213
if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
214
#else
215
static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
216
if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
217
#endif
218
219
// reset the text renderer
220
TextRenderer::reset_buffer();
221
222
// frame reset
172
223
if( reset ) {
173
second = 0;
174
segment = 0;
175
}
176
177
// what needs to be drawn?
178
bool draw_tick = second % 5 == 0;
179
bool draw_second = second == time_seconds;
180
bool draw_minute = second == time_minute;
181
bool draw_hour = 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
}
224
switch( _major_mode ) {
225
case MAIN_MODE_IDX:
226
switch( _minor_mode ) {
227
case ANALOGUE_CLOCK_IDX: analogue_clock_draw_reset(); break;
228
case DIGITAL_CLOCK_IDX: digital_clock_draw_reset(); break;
229
case INFO_MODE_IDX: info_mode_draw_reset(); break;
230
}
231
break;
232
case SETTINGS_MODE_IDX: settings_mode_draw_reset(); break;
233
}
234
235
// tell the text services we're starting a new frame
236
Text::draw_reset();
237
}
238
239
// draw
240
switch( _major_mode ) {
241
case MAIN_MODE_IDX:
242
switch( _minor_mode ) {
243
case ANALOGUE_CLOCK_IDX: analogue_clock_draw( segment ); break;
244
case DIGITAL_CLOCK_IDX: digital_clock_draw( segment ); break;
245
case TEST_PATTERN_IDX: test_pattern_draw( segment ); break;
246
case INFO_MODE_IDX: info_mode_draw( segment ); break;
247
}
248
break;
249
case SETTINGS_MODE_IDX: settings_mode_draw( segment ); break;
250
}
251
252
// draw any text that was rendered
253
TextRenderer::output_buffer();
254
255
#if CLOCK_FORWARD
256
if( ++segment >= NUM_SEGMENTS ) segment = 0;
257
#else
258
if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
259
#endif
217
260
}
218
261
219
262
220
263
// calculate time constants when a new pulse has occurred
221
void calculateSegmentTimes()
264
void calculate_segment_times()
222
265
{
223
266
// check for overflows, and only recalculate times if there isn't
224
267
// one (if there is, we'll just go with the last pulse's times)
225
if( new_pulse_at > last_pulse_at )
268
if( _new_pulse_at > _last_pulse_at )
226
269
{
227
270
// 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;
271
unsigned long delta = _new_pulse_at - _last_pulse_at;
272
_segment_step = delta / NUM_SEGMENTS;
273
_segment_step_sub = 0;
274
_segment_step_sub_step = delta % NUM_SEGMENTS;
232
275
}
233
276
234
277
// now we have dealt with this pulse, save the pulse time and
235
278
// clear new_pulse_at, ready for the next pulse
236
last_pulse_at = new_pulse_at;
237
new_pulse_at = 0;
279
_last_pulse_at = _new_pulse_at;
280
_new_pulse_at = 0;
238
281
}
239
282
240
283
241
284
// wait until it is time to draw the next segment or a new pulse has
242
285
// occurred
243
void waitTillNextSegment( bool reset )
286
void wait_till_end_of_segment( bool reset )
244
287
{
245
288
static unsigned long end_time = 0;
246
289
247
290
// handle reset
248
291
if( reset )
249
end_time = last_pulse_at;
292
end_time = _last_pulse_at;
250
293
251
294
// 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;
295
end_time += _segment_step;
296
_segment_step_sub += _segment_step_sub_step;
297
if( _segment_step_sub >= NUM_SEGMENTS ) {
298
_segment_step_sub -= NUM_SEGMENTS;
256
299
end_time++;
257
300
}
258
301
259
302
// wait
260
while( micros() < end_time && !new_pulse_at );
303
while( micros() < end_time && !_new_pulse_at );
261
304
}
262
305
263
306
264
// ISR to handle the pulses from the fan's tachiometer
265
void fanPulseHandler()
307
// ISR to handle the pulses from the fan's tachometer
308
void fan_pulse_handler()
266
309
{
267
310
// the fan actually sends two pulses per revolution. These pulses
268
311
// may not be exactly evenly distributed around the rotation, so
273
316
if( !ignore )
274
317
{
275
318
// set a new pulse time
276
new_pulse_at = micros();
319
_new_pulse_at = micros();
277
320
}
278
321
}
279
322
281
324
// main setup
282
325
void setup()
283
326
{
284
// set up an interrupt handler on pin 2 to nitice fan pulses
285
attachInterrupt( 0, fanPulseHandler, RISING );
327
// set up an interrupt handler on pin 2 to notice fan pulses
328
attachInterrupt( 0, fan_pulse_handler, RISING );
286
329
digitalWrite( 2, HIGH );
287
330
288
331
// set up output pins (4 to 13) for the led array
291
334
292
335
// set up mode-switch button on pin 3
293
336
pinMode( 3, INPUT );
294
295
// serial comms
296
Serial.begin( 9600 );
337
digitalWrite( 3, HIGH );
338
static int event_times[] = { 5, 500, 4000, 0 };
339
_button.set_event_times( event_times );
340
341
// initialise RTC
342
Time::init();
343
344
// init text renderer
345
TextRenderer::init();
346
347
// activate the minor mode
348
activate_major_mode();
297
349
}
298
350
299
351
301
353
void loop()
302
354
{
303
355
// if there has been a new pulse, we'll be resetting the display
304
bool reset = new_pulse_at? true : false;
356
bool reset = _new_pulse_at? true : false;
357
358
// update button
359
_button.update();
305
360
306
361
// only do this stuff at the start of a display cycle, to ensure
307
362
// that no state changes mid-display
308
363
if( reset )
309
364
{
310
// check buttons
311
checkButtons();
365
// calculate segment times
366
calculate_segment_times();
312
367
313
368
// keep track of time
314
trackTime();
369
Time::update();
370
371
// perform button events
372
do_button_events();
315
373
}
316
374
317
375
// draw this segment
318
drawNextSegment( reset );
319
320
// do we need to recalculate segment times?
321
if( reset )
322
calculateSegmentTimes();
376
draw_next_segment( reset );
323
377
324
378
// wait till it's time to draw the next segment
325
waitTillNextSegment( reset );
379
wait_till_end_of_segment( reset );
326
380
}
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0