/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.ino

  • Committer: edam
  • Date: 2012-02-28 17:11:15 UTC
  • Revision ID: edam@waxworlds.org-20120228171115-j3k91a3v71d3wnc1
cleanu

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/propeller-clock.ino
 
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
21
22
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23
 */
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 (tachiometer) 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 anf 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 analog 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 tachiometer 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 dicsover 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 "display.h"
 
80
#include "button.h"
 
81
#include "time.h"
 
82
#include "switcher_major_mode.h"
 
83
#include "drawer.h"
 
84
 
24
85
//_____________________________________________________________________________
25
86
//                                                                         data
26
87
 
40
101
static unsigned long segment_step_sub_step = 0;
41
102
static unsigned long segment_step_sub = 0;
42
103
 
43
 
// display mode
44
 
static
45
 
 
 
104
// the button
 
105
static Button button( 3 );
 
106
 
 
107
// major mode
 
108
static int major_mode = 0;
 
109
 
 
110
#define MAX_MAJOR_MODES 5
 
111
 
 
112
// major modes
 
113
static MajorMode *major_modes[ MAX_MAJOR_MODES ] = { 0 };
46
114
 
47
115
//_____________________________________________________________________________
48
116
//                                                                         code
49
117
 
50
118
 
51
 
// ISR to handle the pulses from the fan's tachiometer
52
 
void fanPulseHandler()
 
119
// perform button events
 
120
void doButtonEvents()
53
121
{
54
 
        // the fan actually sends two pulses per revolution. These pulses
55
 
        // may not be exactly evenly distributed around the rotation, so
56
 
        // we can't recalculate times on every pulse. Instead, we ignore
57
 
        // every other pulse so timings are based on a complete rotation.
58
 
        static bool ignore = true;
59
 
        ignore = !ignore;
60
 
        if( !ignore )
 
122
        // loop through pending events
 
123
        while( int event = button.get_event() )
61
124
        {
62
 
                // set a new pulse time
63
 
                new_pulse_at = micros();
 
125
                switch( event )
 
126
                {
 
127
                case 1:
 
128
                        // short press
 
129
                        major_modes[ major_mode ]->press();
 
130
                        break;
 
131
 
 
132
                case 2:
 
133
                        // long press
 
134
                        major_modes[ major_mode ]->long_press();
 
135
                        break;
 
136
 
 
137
                case 3:
 
138
                        // looooong press (change major mode)
 
139
                        do {
 
140
                                if( ++major_mode >= MAX_MAJOR_MODES )
 
141
                                        major_mode = 0;
 
142
                        } while( major_modes[ major_mode ] == NULL );
 
143
                        major_modes[ major_mode ]->activate();
 
144
                        break;
 
145
 
 
146
                }
64
147
        }
65
148
}
66
149
 
67
150
 
68
 
// draw a particular segment
 
151
// draw a display segment
69
152
void drawNextSegment( bool reset )
70
153
{
71
 
        static unsigned int segment = 0;
72
 
        if( reset ) segment = 0;
73
 
        segment++;
74
 
 
75
 
        for( int a = 0; a < 10; a++ )
76
 
                digitalWrite( a + 4, ( ( segment >> a ) & 1 )? HIGH : LOW );
 
154
        // keep track of segment
 
155
#if CLOCK_FORWARD
 
156
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
157
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
158
#else
 
159
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
160
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
161
#endif
 
162
 
 
163
        // draw
 
164
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
 
165
        if( reset ) drawer.draw_reset();
 
166
        drawer.draw( segment );
 
167
 
 
168
#if CLOCK_FORWARD
 
169
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
170
#else
 
171
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
172
#endif
77
173
}
78
174
 
79
175
 
100
196
 
101
197
// wait until it is time to draw the next segment or a new pulse has
102
198
// occurred
103
 
void waitTillNextSegment( bool reset )
 
199
void waitTillEndOfSegment( bool reset )
104
200
{
105
201
        static unsigned long end_time = 0;
106
202
 
110
206
 
111
207
        // work out the time that this segment should be displayed until
112
208
        end_time += segment_step;
113
 
        semgment_step_sub += semgment_step_sub_step;
114
 
        if( semgment_step_sub >= NUM_SEGMENTS ) {
115
 
                semgment_step_sub -= NUM_SEGMENTS;
 
209
        segment_step_sub += segment_step_sub_step;
 
210
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
211
                segment_step_sub -= NUM_SEGMENTS;
116
212
                end_time++;
117
213
        }
118
214
 
121
217
}
122
218
 
123
219
 
 
220
// ISR to handle the pulses from the fan's tachiometer
 
221
void fanPulseHandler()
 
222
{
 
223
        // the fan actually sends two pulses per revolution. These pulses
 
224
        // may not be exactly evenly distributed around the rotation, so
 
225
        // we can't recalculate times on every pulse. Instead, we ignore
 
226
        // every other pulse so timings are based on a complete rotation.
 
227
        static bool ignore = true;
 
228
        ignore = !ignore;
 
229
        if( !ignore )
 
230
        {
 
231
                // set a new pulse time
 
232
                new_pulse_at = micros();
 
233
        }
 
234
}
 
235
 
 
236
 
124
237
// main setup
125
238
void setup()
126
239
{
132
245
        for( int a = 4; a < 14; a++ )
133
246
                pinMode( a, OUTPUT );
134
247
 
135
 
        // serial comms
136
 
        Serial.begin( 9600 );
 
248
        // set up mode-switch button on pin 3
 
249
        pinMode( 3, INPUT );
 
250
        digitalWrite( 3, HIGH );
 
251
        static int event_times[] = { 5, 1000, 4000, 0 };
 
252
        button.set_event_times( event_times );
 
253
 
 
254
        // set up major modes
 
255
        static SwitcherMajorMode switcher_major_mode;
 
256
        int mode = 0;
 
257
        major_modes[ mode++ ] = &switcher_major_mode;
 
258
        major_modes[ 0 ]->activate();
137
259
}
138
260
 
139
261
 
143
265
        // if there has been a new pulse, we'll be resetting the display
144
266
        bool reset = new_pulse_at? true : false;
145
267
 
 
268
        // update button
 
269
        button.update();
 
270
 
 
271
        // only do this stuff at the start of a display cycle, to ensure
 
272
        // that no state changes mid-display
 
273
        if( reset )
 
274
        {
 
275
                // calculate segment times
 
276
                calculateSegmentTimes();
 
277
 
 
278
                // keep track of time
 
279
                Time &time = Time::get_instance();
 
280
                time.update();
 
281
 
 
282
                // perform button events
 
283
                doButtonEvents();
 
284
        }
 
285
 
146
286
        // draw this segment
147
287
        drawNextSegment( reset );
148
288
 
149
 
        // do we need to recalculate segment times?
150
 
        if( reset )
151
 
                calculateSegmentTimes();
152
 
 
153
289
        // wait till it's time to draw the next segment
154
 
        waitTillNextSegment( reset );
 
290
        waitTillEndOfSegment( reset );
155
291
}