/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: edam
  • Date: 2012-05-18 12:11:01 UTC
  • Revision ID: tim@ed.am-20120518121101-0wik922hyvjkcjdi
switched back to using classes for modes

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
27
28
 
28
29
 * a PC fan is wired up to a 12V power supply
29
30
 
30
 
 * the fan's SENSE (tachiometer) pin connected to pin 2 on the
31
 
   arduino.
 
31
 * the fan's SENSE (tachometer) pin connected to pin 2 on the
 
32
   Arduino.
32
33
 
33
 
 * the pins 4 to 13 on the arduino should directly drive an LED (the
 
34
 * the pins 4 to 13 on the Arduino should directly drive an LED (the
34
35
   LED on pin 4 is in the centre of the clock face and the LED on pin
35
36
   13 is at the outside.
36
37
 
37
38
 * if a longer hand (and a larger clock face) is desired, pin 4 can be
38
 
   used to indirectly drive (via a MOSFET) multiple LEDs which turn on
39
 
   and off in unison in the centre of the clock.
 
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.
40
41
 
41
42
 * a button should be attached to pin 3 that grounds it when pressed.
42
43
 
 
44
 * A DS1307 remote clock is connected via I2C on analogue pins 4 and 5.
 
45
 
43
46
Implementation details:
44
47
 
45
 
 * for a schematic, see project/propeller-clock.sch.
 
48
 * for a schematic, see ../project/propeller-clock.sch.
46
49
 
47
50
 * the timing of the drawing of the clock face is recalculated with
48
51
   every rotation of the propeller.
49
52
    
50
 
 * a PC fan actually sends 2 tachiometer pulses per revolution, so the
 
53
 * a PC fan actually sends 2 tachometer pulses per revolution, so the
51
54
   software skips every other one. This means that the clock may
52
55
   appear upside-down if started with the propeller in the wrong
53
 
   position. You will need to experiment to dicsover the position that
 
56
   position. You will need to experiment to discover the position that
54
57
   the propeller must be in when starting the clock.
55
58
    
56
59
Usage instructions:
67
70
    - pressing the button increments the field currently being set
68
71
    - pressing and holding the button for a second cycles through the
69
72
      fields that can be set
70
 
    - press and holding the button for 5 seconds to finish
 
73
    - pressing and holding the button for 5 seconds sets the time and
 
74
      exits "time set" mode
71
75
 
72
76
******************************************************************************/
73
77
 
74
 
 
75
 
#include <Bounce.h>
 
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"
76
91
 
77
92
//_____________________________________________________________________________
78
93
//                                                                         data
79
94
 
80
 
 
81
95
// when non-zero, the time (in microseconds) of a new fan pulse that
82
96
// has just occurred, which means that segment drawing needs to be
83
97
// restarted
84
 
static unsigned long new_pulse_at = 0;
 
98
static unsigned long _new_pulse_at = 0;
85
99
 
86
100
// the time (in microseconds) when the last fan pulse occurred
87
 
static unsigned long last_pulse_at = 0;
 
101
static unsigned long _last_pulse_at = 0;
88
102
 
89
103
// duration (in microseconds) that a segment should be displayed
90
 
static unsigned long segment_step = 0;
 
104
static unsigned long _segment_step = 0;
91
105
 
92
106
// remainder after divisor and a tally of the remainders for each segment
93
 
static unsigned long segment_step_sub_step = 0;
94
 
static unsigned long segment_step_sub = 0;
95
 
 
96
 
// flag to indicate that the drawing mode should be cycled to the next one
97
 
static bool inc_draw_mode = false;
98
 
 
99
 
// a bounce-managed button
100
 
static Bounce button( 3, 5 );
101
 
 
102
 
// the time
103
 
static int time_hours = 0;
104
 
static int time_minutes = 0;
105
 
static int time_seconds = 0;
106
 
 
107
 
// number of segments in a full display (rotation) is 60 (one per
108
 
// second) times the desired number of sub-divisions of a second
109
 
#define NUM_SECOND_SEGMENTS 5
110
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
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;
111
118
 
112
119
//_____________________________________________________________________________
113
120
//                                                                         code
114
121
 
115
 
 
116
 
// check for button presses
117
 
void checkButtons()
118
 
{
119
 
        // update buttons
120
 
        button.update();
121
 
 
122
 
        // notice button presses
123
 
        if( button.risingEdge() )
124
 
                inc_draw_mode = true;
125
 
}
126
 
 
127
 
 
128
 
// keep track of time
129
 
void trackTime()
130
 
{
131
 
        // previous time and any carried-over milliseconds
132
 
        static unsigned long last_time = millis();
133
 
        static unsigned long carry = 0;
134
 
 
135
 
        // how many milliseonds have elapsed since we last checked?
136
 
        unsigned long next_time = millis();
137
 
        unsigned long delta = next_time - last_time + carry;
138
 
 
139
 
        // update the previous time and carried-over milliseconds
140
 
        last_time = next_time;
141
 
        carry = delta % 1000;
142
 
 
143
 
        // add the seconds that have passed to the time
144
 
        time_seconds += delta / 1000;
145
 
        while( time_seconds >= 60 ) {
146
 
                time_seconds -= 60;
147
 
                time_minutes++;
148
 
                if( time_minutes >= 60 ) {
149
 
                        time_minutes -= 60;
150
 
                        time_hours++;
151
 
                        if( time_hours >= 24 )
152
 
                                time_hours -= 24;
 
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;
153
144
                }
154
145
        }
155
146
}
156
147
 
157
148
 
158
 
// draw a segment for the test display
159
 
void drawNextSegment_test( bool reset )
 
149
// draw a display segment
 
150
void draw_next_segment( bool reset )
160
151
{
161
152
        // keep track of segment
162
 
        static unsigned int segment = 0;
163
 
        if( reset ) segment = 0;
164
 
        segment++;
165
 
 
166
 
        // turn on inside and outside LEDs
167
 
        digitalWrite( 4, HIGH );
168
 
        digitalWrite( 13, HIGH );
169
 
 
170
 
        // display segment number in binary across in the inside LEDs,
171
 
        // with the LED on pin 12 showing the least-significant bit
172
 
        for( int a = 0; a < 8; a++ )
173
 
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
174
 
}
175
 
 
176
 
 
177
 
// draw a segment for the time display
178
 
void drawNextSegment_time( bool reset )
179
 
{
180
 
        static unsigned int second = 0;
181
 
        static unsigned int segment = 0;
182
 
 
183
 
        // handle display reset
184
 
        if( reset ) {
185
 
                second = 0;
186
 
                segment = 0;
187
 
        }
188
 
 
189
 
        // what needs to be drawn?
190
 
        bool draw_tick = !segment && second % 5 == 0;
191
 
        bool draw_second = !segment && second == time_seconds;
192
 
        bool draw_minute = !segment && second == time_minute;
193
 
        bool draw_hour = !segment && second == time_hour;
194
 
 
195
 
        // set the LEDs
196
 
        digitalWrite( 13, HIGH );
197
 
        digitalWrite( 12, draw_tick || draw_minute );
198
 
        for( int a = 10; a <= 11; a++ )
199
 
                digitalWrite( a, draw_minute || draw_second );
200
 
        for( int a = 4; a <= 9; a++ )
201
 
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
202
 
 
203
 
        // inc position
204
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
205
 
                segment = 0;
206
 
                second++;
207
 
        }
208
 
}
209
 
 
210
 
 
211
 
// draw a display segment
212
 
void drawNextSegment( bool reset )
213
 
{
214
 
        static int draw_mode = 0;
215
 
 
216
 
        // handle mode switch requests
217
 
        if( reset && inc_draw_mode ) {
218
 
                inc_draw_mode = false;
219
 
                draw_mode++;
220
 
                if( draw_mode >= 2 )
221
 
                        draw_mode = 0;
222
 
        }
223
 
 
224
 
        // draw the segment
225
 
        switch( draw_mode ) {
226
 
        case 0: drawNextSegment_test( reset ); break;
227
 
        case 1: drawNextSegment_time( reset ); break;
228
 
        }
 
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
229
186
}
230
187
 
231
188
 
232
189
// calculate time constants when a new pulse has occurred
233
 
void calculateSegmentTimes()
 
190
void calculate_segment_times()
234
191
{
235
192
        // check for overflows, and only recalculate times if there isn't
236
193
        // one (if there is, we'll just go with the last pulse's times)
237
 
        if( new_pulse_at > last_pulse_at )
 
194
        if( _new_pulse_at > _last_pulse_at )
238
195
        {
239
196
                // new segment stepping times
240
 
                unsigned long delta = new_pulse_at - last_pulse_at;
241
 
                segment_step = delta / NUM_SEGMENTS;
242
 
                segment_step_sub = 0;
243
 
                segment_step_sub_step = delta % NUM_SEGMENTS;
 
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;
244
201
        }
245
202
 
246
203
        // now we have dealt with this pulse, save the pulse time and
247
204
        // clear new_pulse_at, ready for the next pulse
248
 
        last_pulse_at = new_pulse_at;
249
 
        new_pulse_at = 0;
 
205
        _last_pulse_at = _new_pulse_at;
 
206
        _new_pulse_at = 0;
250
207
}
251
208
 
252
209
 
253
210
// wait until it is time to draw the next segment or a new pulse has
254
211
// occurred
255
 
void waitTillNextSegment( bool reset )
 
212
void wait_till_end_of_segment( bool reset )
256
213
{
257
214
        static unsigned long end_time = 0;
258
215
 
259
216
        // handle reset
260
217
        if( reset )
261
 
                end_time = last_pulse_at;
 
218
                end_time = _last_pulse_at;
262
219
 
263
220
        // work out the time that this segment should be displayed until
264
 
        end_time += segment_step;
265
 
        segment_step_sub += segment_step_sub_step;
266
 
        if( segment_step_sub >= NUM_SEGMENTS ) {
267
 
                segment_step_sub -= NUM_SEGMENTS;
 
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;
268
225
                end_time++;
269
226
        }
270
227
 
271
228
        // wait
272
 
        while( micros() < end_time && !new_pulse_at );
 
229
        while( micros() < end_time && !_new_pulse_at );
273
230
}
274
231
 
275
232
 
276
 
// ISR to handle the pulses from the fan's tachiometer
277
 
void fanPulseHandler()
 
233
// ISR to handle the pulses from the fan's tachometer
 
234
void fan_pulse_handler()
278
235
{
279
236
        // the fan actually sends two pulses per revolution. These pulses
280
237
        // may not be exactly evenly distributed around the rotation, so
285
242
        if( !ignore )
286
243
        {
287
244
                // set a new pulse time
288
 
                new_pulse_at = micros();
 
245
                _new_pulse_at = micros();
289
246
        }
290
247
}
291
248
 
293
250
// main setup
294
251
void setup()
295
252
{
296
 
        // set up an interrupt handler on pin 2 to nitice fan pulses
297
 
        attachInterrupt( 0, fanPulseHandler, RISING );
 
253
        // set up an interrupt handler on pin 2 to notice fan pulses
 
254
        attachInterrupt( 0, fan_pulse_handler, RISING );
298
255
        digitalWrite( 2, HIGH );
299
256
  
300
257
        // set up output pins (4 to 13) for the led array
303
260
 
304
261
        // set up mode-switch button on pin 3
305
262
        pinMode( 3, INPUT );
306
 
 
307
 
        // serial comms
308
 
        Serial.begin( 9600 );
 
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();
309
288
}
310
289
 
311
290
 
313
292
void loop()
314
293
{
315
294
        // if there has been a new pulse, we'll be resetting the display
316
 
        bool reset = new_pulse_at? true : false;
 
295
        bool reset = _new_pulse_at? true : false;
 
296
 
 
297
        // update button
 
298
        _button.update();
317
299
 
318
300
        // only do this stuff at the start of a display cycle, to ensure
319
301
        // that no state changes mid-display
320
302
        if( reset )
321
303
        {
322
 
                // check buttons
323
 
                checkButtons();
 
304
                // calculate segment times
 
305
                calculate_segment_times();
324
306
 
325
307
                // keep track of time
326
 
                trackTime();
 
308
                Time::update();
 
309
 
 
310
                // perform button events
 
311
                do_button_events();
327
312
        }
328
313
 
329
314
        // draw this segment
330
 
        drawNextSegment( reset );
331
 
 
332
 
        // do we need to recalculate segment times?
333
 
        if( reset )
334
 
                calculateSegmentTimes();
 
315
        draw_next_segment( reset );
335
316
 
336
317
        // wait till it's time to draw the next segment
337
 
        waitTillNextSegment( reset );
 
318
        wait_till_end_of_segment( reset );
338
319
}