/elec/propeller-clock

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

  • Committer: Tim Marston
  • Date: 2013-03-31 17:07:11 UTC
  • Revision ID: tim@ed.am-20130331170711-okfhn3wx9y0eo99a
updated the schematic to increase minimum font size

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.cc
 
1
/* -*- mode: c++; compile-command: "make"; -*- */
 
2
/*
 
3
 * propeller-clock.ino
 
4
 *
 
5
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
6
 *
 
7
 * 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
 
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
 
 
25
/******************************************************************************
 
26
 
 
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
 
75
 
 
76
******************************************************************************/
 
77
 
 
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"
 
91
 
 
92
//_____________________________________________________________________________
 
93
//                                                                         data
 
94
 
 
95
// when non-zero, the time (in microseconds) of a new fan pulse that
 
96
// has just occurred, which means that segment drawing needs to be
 
97
// restarted
 
98
static unsigned long _new_pulse_at = 0;
 
99
 
 
100
// the time (in microseconds) when the last fan pulse occurred
 
101
static unsigned long _last_pulse_at = 0;
 
102
 
 
103
// duration (in microseconds) that a segment should be displayed
 
104
static unsigned long _segment_step = 0;
 
105
 
 
106
// 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;
 
118
 
 
119
// interupt handler's "ignore every other" flag
 
120
static bool _pulse_ignore = true;
 
121
 
 
122
//_____________________________________________________________________________
 
123
//                                                                         code
 
124
 
 
125
// perform button events
 
126
void do_button_events()
 
127
{
 
128
        // loop through pending events
 
129
        while( int event = _button.get_event() )
 
130
        {
 
131
                switch( event )
 
132
                {
 
133
                case 1:
 
134
                        // short press
 
135
                        _modes[ _mode ]->press();
 
136
                        break;
 
137
                case 2:
 
138
                        // long press
 
139
                        _modes[ _mode ]->long_press();
 
140
                        break;
 
141
                case 3:
 
142
                        // looooong press (change major mode)
 
143
                        _modes[ _mode ]->deactivate();
 
144
                        if( !_modes[ ++_mode ] ) _mode = 0;
 
145
                        _modes[ _mode ]->activate();
 
146
                        break;
 
147
                case 4:
 
148
                        // switch display upside-down
 
149
                        _pulse_ignore = !_pulse_ignore;
 
150
                        break;
 
151
                }
 
152
        }
 
153
}
 
154
 
 
155
 
 
156
// draw a display segment
 
157
void draw_next_segment( bool reset )
 
158
{
 
159
        // keep track of segment
 
160
        static int segment = 0;
 
161
#if CLOCK_FORWARD
 
162
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
163
#else
 
164
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
165
#endif
 
166
 
 
167
        // reset the text renderer's buffer
 
168
        TextRenderer::reset_buffer();
 
169
 
 
170
        if( reset )
 
171
        {
 
172
                _modes[ _mode ]->draw_reset();
 
173
 
 
174
                // tell the text services we're starting a new frame
 
175
                Text::draw_reset();
 
176
        }
 
177
 
 
178
        // draw
 
179
        _modes[ _mode ]->draw( segment );
 
180
 
 
181
        // draw text
 
182
        Text::draw( segment );
 
183
 
 
184
        // draw text rednerer's buffer
 
185
        TextRenderer::output_buffer();
 
186
 
 
187
#if CLOCK_FORWARD
 
188
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
189
#else
 
190
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
191
#endif
 
192
}
 
193
 
 
194
 
 
195
// calculate time constants when a new pulse has occurred
 
196
void calculate_segment_times()
 
197
{
 
198
        // check for overflows, and only recalculate times if there isn't
 
199
        // one (if there is, we'll just go with the last pulse's times)
 
200
        if( _new_pulse_at > _last_pulse_at )
 
201
        {
 
202
                // new segment stepping times
 
203
                unsigned long delta = _new_pulse_at - _last_pulse_at;
 
204
                _segment_step = delta / NUM_SEGMENTS;
 
205
                _segment_step_sub = 0;
 
206
                _segment_step_sub_step = delta % NUM_SEGMENTS;
 
207
        }
 
208
 
 
209
        // now we have dealt with this pulse, save the pulse time and
 
210
        // clear new_pulse_at, ready for the next pulse
 
211
        _last_pulse_at = _new_pulse_at;
 
212
        _new_pulse_at = 0;
 
213
}
 
214
 
 
215
 
 
216
// wait until it is time to draw the next segment or a new pulse has
 
217
// occurred
 
218
void wait_till_end_of_segment( bool reset )
 
219
{
 
220
        static unsigned long end_time = 0;
 
221
 
 
222
        // handle reset
 
223
        if( reset )
 
224
                end_time = _last_pulse_at;
 
225
 
 
226
        // work out the time that this segment should be displayed until
 
227
        end_time += _segment_step;
 
228
        _segment_step_sub += _segment_step_sub_step;
 
229
        if( _segment_step_sub >= NUM_SEGMENTS ) {
 
230
                _segment_step_sub -= NUM_SEGMENTS;
 
231
                end_time++;
 
232
        }
 
233
 
 
234
        // wait
 
235
        while( micros() < end_time && !_new_pulse_at );
 
236
}
 
237
 
 
238
 
 
239
// ISR to handle the pulses from the fan's tachometer
 
240
void fan_pulse_handler()
 
241
{
 
242
        // the fan actually sends two pulses per revolution. These pulses
 
243
        // may not be exactly evenly distributed around the rotation, so
 
244
        // we can't recalculate times on every pulse. Instead, we ignore
 
245
        // every other pulse so timings are based on a complete rotation.
 
246
        _pulse_ignore = !_pulse_ignore;
 
247
        if( !_pulse_ignore )
 
248
        {
 
249
                // set a new pulse time
 
250
                _new_pulse_at = micros();
 
251
        }
 
252
}
 
253
 
 
254
 
 
255
// main setup
 
256
void setup()
 
257
{
 
258
        // set up an interrupt handler on pin 2 to notice fan pulses
 
259
        attachInterrupt( 0, fan_pulse_handler, RISING );
 
260
        digitalWrite( 2, HIGH );
 
261
  
 
262
        // set up output pins (4 to 13) for the led array
 
263
        for( int a = 4; a < 14; a++ )
 
264
                pinMode( a, OUTPUT );
 
265
 
 
266
        // set up mode-switch button on pin 3
 
267
        pinMode( 3, INPUT );
 
268
        digitalWrite( 3, HIGH );
 
269
        static int event_times[] = { 10, 500, 2000, 4000, 0 };
 
270
        _button.set_event_times( event_times );
 
271
 
 
272
        // initialise RTC
 
273
        Time::load_time();
 
274
 
 
275
        // init text renderer
 
276
        TextRenderer::init();
 
277
 
 
278
        // reset text
 
279
        Text::reset();
 
280
        leds_off();
 
281
 
 
282
        static SwitcherMajorMode switcher;
 
283
        static SettingsMajorMode settings( _button );
 
284
 
 
285
        // add major modes
 
286
        int mode = 0;
 
287
        _modes[ mode++ ] = &switcher;
 
288
        _modes[ mode++ ] = &settings;
 
289
        _modes[ mode ] = 0;
 
290
 
 
291
        // activate the current major mode
 
292
        _modes[ _mode ]->activate();
 
293
}
 
294
 
 
295
 
 
296
// main loop
 
297
void loop()
 
298
{
 
299
        // if there has been a new pulse, we'll be resetting the display
 
300
        bool reset = _new_pulse_at? true : false;
 
301
 
 
302
        // update button
 
303
        _button.update();
 
304
 
 
305
        // only do this stuff at the start of a display cycle, to ensure
 
306
        // that no state changes mid-display
 
307
        if( reset )
 
308
        {
 
309
                // calculate segment times
 
310
                calculate_segment_times();
 
311
 
 
312
                // keep track of time
 
313
                Time::update();
 
314
 
 
315
                // perform button events
 
316
                do_button_events();
 
317
        }
 
318
 
 
319
        // draw this segment
 
320
        draw_next_segment( reset );
 
321
 
 
322
        // wait till it's time to draw the next segment
 
323
        wait_till_end_of_segment( reset );
 
324
}