/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-25 14:54:33 UTC
  • Revision ID: edam@waxworlds.org-20120225145433-kih8qs45x05cum46
removed Bounce library and updated/fixed new code

Show diffs side-by-side

added added

removed removed

 
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 "button.h"
 
79
#include "config.h"
 
80
#include "time.h"
 
81
#include "mode_switcher.h"
 
82
#include "drawer.h"
 
83
 
24
84
//_____________________________________________________________________________
25
85
//                                                                         data
26
86
 
40
100
static unsigned long segment_step_sub_step = 0;
41
101
static unsigned long segment_step_sub = 0;
42
102
 
43
 
// display mode
44
 
static
45
 
 
 
103
// the button
 
104
static Button button( 3 );
 
105
 
 
106
// major mode
 
107
static int major_mode = 0;
 
108
 
 
109
// major modes
 
110
static std::vector< MajorMode * > major_modes;
46
111
 
47
112
//_____________________________________________________________________________
48
113
//                                                                         code
49
114
 
50
115
 
51
 
// ISR to handle the pulses from the fan's tachiometer
52
 
void fanPulseHandler()
 
116
// check for button presses
 
117
void checkButtons()
53
118
{
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 )
61
 
        {
62
 
                // set a new pulse time
63
 
                new_pulse_at = micros();
 
119
        // update buttons
 
120
        int event = button.update();
 
121
 
 
122
        // handle any events
 
123
        switch( event ) {
 
124
        case 1:
 
125
                major_modes[ major_mode ]->short_press();
 
126
                break;
 
127
        case 2:
 
128
                major_modes[ major_mode ]->long_press();
 
129
                break;
 
130
        case 3:
 
131
                if( ++major_mode >= major_modes.size() )
 
132
                        major_mode = 0;
 
133
                major_modes[ major_mode ]->activate();
 
134
                break;
64
135
        }
65
136
}
66
137
 
67
138
 
68
 
// draw a particular segment
 
139
// draw a display segment
69
140
void drawNextSegment( bool reset )
70
141
{
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 );
 
142
        // keep track of segment
 
143
#if CLOCK_FORWARD
 
144
        static int segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
145
        if( reset ) segment = ( NUM_SEGMENTS - CLOCK_SHIFT ) % NUM_SEGMENTS;
 
146
#else
 
147
        static int segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
148
        if( reset ) segment = NUM_SEGMENTS - 1 - CLOCK_SHIFT;
 
149
#endif
 
150
 
 
151
        // draw
 
152
        Drawer &drawer = major_modes[ major_mode ]->get_drawer();
 
153
        if( reset ) drawer.draw_reset();
 
154
        drawer.draw( segment );
 
155
 
 
156
#if CLOCK_FORWARD
 
157
        if( ++segment >= NUM_SEGMENTS ) segment = 0;
 
158
#else
 
159
        if( --segment < 0 ) segment = NUM_SEGMENTS - 1;
 
160
#endif
77
161
}
78
162
 
79
163
 
110
194
 
111
195
        // work out the time that this segment should be displayed until
112
196
        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;
 
197
        segment_step_sub += segment_step_sub_step;
 
198
        if( segment_step_sub >= NUM_SEGMENTS ) {
 
199
                segment_step_sub -= NUM_SEGMENTS;
116
200
                end_time++;
117
201
        }
118
202
 
121
205
}
122
206
 
123
207
 
 
208
// ISR to handle the pulses from the fan's tachiometer
 
209
void fanPulseHandler()
 
210
{
 
211
        // the fan actually sends two pulses per revolution. These pulses
 
212
        // may not be exactly evenly distributed around the rotation, so
 
213
        // we can't recalculate times on every pulse. Instead, we ignore
 
214
        // every other pulse so timings are based on a complete rotation.
 
215
        static bool ignore = true;
 
216
        ignore = !ignore;
 
217
        if( !ignore )
 
218
        {
 
219
                // set a new pulse time
 
220
                new_pulse_at = micros();
 
221
        }
 
222
}
 
223
 
 
224
 
124
225
// main setup
125
226
void setup()
126
227
{
132
233
        for( int a = 4; a < 14; a++ )
133
234
                pinMode( a, OUTPUT );
134
235
 
 
236
        // set up mode-switch button on pin 3
 
237
        pinMode( 3, INPUT );
 
238
        digitalWrite( 3, HIGH );
 
239
        button.add_event_at( 5, 1 );
 
240
        button.add_event_at( 1000, 2 );
 
241
        button.add_event_at( 4000, 3 );
 
242
 
135
243
        // serial comms
136
244
        Serial.begin( 9600 );
 
245
 
 
246
        // set up major modes
 
247
        static ModeSwitcher mode_switcher;
 
248
        major_modes.push_back( &mode_switcher );
 
249
        major_modes[ 0 ]->activate();
137
250
}
138
251
 
139
252
 
143
256
        // if there has been a new pulse, we'll be resetting the display
144
257
        bool reset = new_pulse_at? true : false;
145
258
 
 
259
        // only do this stuff at the start of a display cycle, to ensure
 
260
        // that no state changes mid-display
 
261
        if( reset )
 
262
        {
 
263
                // check buttons
 
264
                checkButtons();
 
265
 
 
266
                // keep track of time
 
267
                Time &time = Time::get_instance();
 
268
                time.update();
 
269
        }
 
270
 
146
271
        // draw this segment
147
272
        drawNextSegment( reset );
148
273