(root)/elec/propeller-clock
» Revision
21
(compared to revision 87)
: propeller-clock/propeller-clock.pde
To get this branch, use:
bzr branch
http://bzr.ed.am/elec/propeller-clock
« back to all changes in this revision
Viewing changes to propeller-clock/propeller-clock.pde
- browse files at revision 21
- compare with another revision
- download diff
- download tarball
- view history from revision 21
- Committer: edam
- Date: 2011-12-02 01:18:26 UTC
- Revision ID: edam@waxworlds.org-20111202011826-uzjcdp535mlb98sl
moved kicad files in to "project" directory, which *in future projects) can hold scematics and PCB designs
- files added:
- propeller-clock/propeller-clock.sch
- files removed:
- arduino.mk
- 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 renamed:
- notes => Notes
- test/ => fan-test/
- test/fan-test/fan-test.ino => fan-test/fan-test.pde
- src/ => propeller-clock/
- src/propeller-clock.cc => propeller-clock/propeller-clock.pde
- src/util/ => propeller-clock/utility/
- files modified:
- .bzrignore
added
removed
propeller-clock/propeller-clock.pde
1
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
1
/*
3
* propeller-clock.ino
2
* propeller-clock.pde
4
3
*
5
* Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
4
* Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
6
5
*
7
6
* This file is part of propeller-clock (hereafter referred to as "this
8
* program"). See http://ed.am/dev/software/arduino/propeller-clock for more
7
* program"). See http://ed.am/software/arduino/propeller-clock for more
9
8
* information.
10
9
*
11
10
* This program is free software: you can redistribute it and/or modify
24
23
25
24
/******************************************************************************
26
25
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
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).
75
59
76
60
******************************************************************************/
77
61
78
#include "config.h"
79
#include "button.h"
80
#include "time.h"
81
#include "Arduino.h"
82
#include "modes/switcher_major_mode.h"
83
#include "modes/settings_major_mode.h"
84
#include "modes/analogue_clock_mode.h"
85
#include "modes/digital_clock_mode.h"
86
#include "modes/info_mode.h"
87
#include "modes/test_pattern_mode.h"
88
#include "text.h"
89
#include "text_renderer.h"
90
#include "common.h"
62
63
#include <Bounce.h>
91
64
92
65
//_____________________________________________________________________________
93
66
// data
94
67
68
95
69
// when non-zero, the time (in microseconds) of a new fan pulse that
96
70
// has just occurred, which means that segment drawing needs to be
97
71
// restarted
98
static unsigned long _new_pulse_at = 0;
72
static unsigned long new_pulse_at = 0;
99
73
100
74
// the time (in microseconds) when the last fan pulse occurred
101
static unsigned long _last_pulse_at = 0;
75
static unsigned long last_pulse_at = 0;
102
76
103
77
// duration (in microseconds) that a segment should be displayed
104
static unsigned long _segment_step = 0;
78
static unsigned long segment_step = 0;
105
79
106
80
// remainder after divisor and a tally of the remainders for each segment
107
static unsigned long _segment_step_sub_step = 0;
108
static unsigned long _segment_step_sub = 0;
109
110
// the button
111
static Button _button( 3 );
112
113
// major modes
114
static MajorMode *_modes[ 3 ];
115
116
// current major mode
117
static int _mode = 0;
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 )
118
99
119
100
//_____________________________________________________________________________
120
101
// code
121
102
122
// perform button events
123
void do_button_events()
124
{
125
// loop through pending events
126
while( int event = _button.get_event() )
127
{
128
switch( event )
129
{
130
case 1:
131
// short press
132
_modes[ _mode ]->press();
133
break;
134
case 2:
135
// long press
136
_modes[ _mode ]->long_press();
137
break;
138
case 3:
139
// looooong press (change major mode)
140
_modes[ _mode ]->deactivate();
141
if( !_modes[ ++_mode ] ) _mode = 0;
142
_modes[ _mode ]->activate();
143
break;
103
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;
144
141
}
145
142
}
146
143
}
147
144
148
145
146
// draw a segment for the test display
147
void drawNextSegment_test( bool reset )
148
{
149
// 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
172
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
149
199
// draw a display segment
150
void draw_next_segment( bool reset )
200
void drawNextSegment( bool reset )
151
201
{
152
// keep track of segment
153
#if CLOCK_FORWARD
154
static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
155
if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
156
#else
157
static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
158
if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
159
#endif
160
161
// reset the text renderer's buffer
162
TextRenderer::reset_buffer();
163
164
if( reset )
165
{
166
_modes[ _mode ]->draw_reset();
167
168
// tell the text services we're starting a new frame
169
Text::draw_reset();
170
}
171
172
// draw
173
_modes[ _mode ]->draw( segment );
174
175
// TODO: remove this hack
176
Text::post_draw();
177
178
// draw text rednerer's buffer
179
TextRenderer::output_buffer();
180
181
#if CLOCK_FORWARD
182
if( ++segment >= NUM_SEGMENTS ) segment = 0;
183
#else
184
if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
185
#endif
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
}
186
217
}
187
218
188
219
189
220
// calculate time constants when a new pulse has occurred
190
void calculate_segment_times()
221
void calculateSegmentTimes()
191
222
{
192
223
// check for overflows, and only recalculate times if there isn't
193
224
// one (if there is, we'll just go with the last pulse's times)
194
if( _new_pulse_at > _last_pulse_at )
225
if( new_pulse_at > last_pulse_at )
195
226
{
196
227
// new segment stepping times
197
unsigned long delta = _new_pulse_at - _last_pulse_at;
198
_segment_step = delta / NUM_SEGMENTS;
199
_segment_step_sub = 0;
200
_segment_step_sub_step = delta % NUM_SEGMENTS;
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;
201
232
}
202
233
203
234
// now we have dealt with this pulse, save the pulse time and
204
235
// clear new_pulse_at, ready for the next pulse
205
_last_pulse_at = _new_pulse_at;
206
_new_pulse_at = 0;
236
last_pulse_at = new_pulse_at;
237
new_pulse_at = 0;
207
238
}
208
239
209
240
210
241
// wait until it is time to draw the next segment or a new pulse has
211
242
// occurred
212
void wait_till_end_of_segment( bool reset )
243
void waitTillNextSegment( bool reset )
213
244
{
214
245
static unsigned long end_time = 0;
215
246
216
247
// handle reset
217
248
if( reset )
218
end_time = _last_pulse_at;
249
end_time = last_pulse_at;
219
250
220
251
// work out the time that this segment should be displayed until
221
end_time += _segment_step;
222
_segment_step_sub += _segment_step_sub_step;
223
if( _segment_step_sub >= NUM_SEGMENTS ) {
224
_segment_step_sub -= NUM_SEGMENTS;
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;
225
256
end_time++;
226
257
}
227
258
228
259
// wait
229
while( micros() < end_time && !_new_pulse_at );
260
while( micros() < end_time && !new_pulse_at );
230
261
}
231
262
232
263
233
// ISR to handle the pulses from the fan's tachometer
234
void fan_pulse_handler()
264
// ISR to handle the pulses from the fan's tachiometer
265
void fanPulseHandler()
235
266
{
236
267
// the fan actually sends two pulses per revolution. These pulses
237
268
// may not be exactly evenly distributed around the rotation, so
242
273
if( !ignore )
243
274
{
244
275
// set a new pulse time
245
_new_pulse_at = micros();
276
new_pulse_at = micros();
246
277
}
247
278
}
248
279
250
281
// main setup
251
282
void setup()
252
283
{
253
// set up an interrupt handler on pin 2 to notice fan pulses
254
attachInterrupt( 0, fan_pulse_handler, RISING );
284
// set up an interrupt handler on pin 2 to nitice fan pulses
285
attachInterrupt( 0, fanPulseHandler, RISING );
255
286
digitalWrite( 2, HIGH );
256
287
257
288
// set up output pins (4 to 13) for the led array
260
291
261
292
// set up mode-switch button on pin 3
262
293
pinMode( 3, INPUT );
263
digitalWrite( 3, HIGH );
264
static int event_times[] = { 5, 500, 4000, 0 };
265
_button.set_event_times( event_times );
266
267
// initialise RTC
268
Time::init();
269
270
// init text renderer
271
TextRenderer::init();
272
273
// reset text
274
Text::reset();
275
leds_off();
276
277
static SwitcherMajorMode switcher;
278
static SettingsMajorMode settings;
279
280
// add major modes
281
int mode = 0;
282
_modes[ mode++ ] = &switcher;
283
_modes[ mode++ ] = &settings;
284
_modes[ mode ] = 0;
285
286
// activate the current major mode
287
_modes[ _mode ]->activate();
294
295
// serial comms
296
Serial.begin( 9600 );
288
297
}
289
298
290
299
292
301
void loop()
293
302
{
294
303
// if there has been a new pulse, we'll be resetting the display
295
bool reset = _new_pulse_at? true : false;
296
297
// update button
298
_button.update();
304
bool reset = new_pulse_at? true : false;
299
305
300
306
// only do this stuff at the start of a display cycle, to ensure
301
307
// that no state changes mid-display
302
308
if( reset )
303
309
{
304
// calculate segment times
305
calculate_segment_times();
310
// check buttons
311
checkButtons();
306
312
307
313
// keep track of time
308
Time::update();
309
310
// perform button events
311
do_button_events();
314
trackTime();
312
315
}
313
316
314
317
// draw this segment
315
draw_next_segment( reset );
318
drawNextSegment( reset );
319
320
// do we need to recalculate segment times?
321
if( reset )
322
calculateSegmentTimes();
316
323
317
324
// wait till it's time to draw the next segment
318
wait_till_end_of_segment( reset );
325
waitTillNextSegment( reset );
319
326
}
Loggerhead is a web-based interface for Bazaar branches
Version: 1.18.2, Revision: 480