/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: 2012-03-09 23:42:20 UTC
  • Revision ID: tim@ed.am-20120309234220-xr1vxzve0o5n2oss
added support for eclipse project and converted to a manual Makefile

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