/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

src/propeller-clock.cc
 
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
23
24
 
24
25
/******************************************************************************
25
26
 
26
 
  For a schematic, see propeller-clock.sch.
27
 
 
28
 
  Set up as follows:
29
 
 
30
 
  - a PC fan is wired up to the 12V supply.
31
 
 
32
 
  - the fan's SENSE (tachiometer) pin is connected to pin 2 on the
33
 
    arduino.
34
 
 
35
 
  - the pins 4 to 13 on the arduino should directly drive an LED (the
36
 
    LED on pin 4 is in the centre of the clock face and the LED on pin
37
 
    13 is at the outside.
38
 
 
39
 
  - if a longer hand (and a larger clock face) is desired, pin 4 can
40
 
    be used to indirectly drive (via a MOSFET) multiple LEDs which
41
 
    turn on and off in unison in the centre of the clock.
42
 
 
43
 
  - a button should be attached to pin 3 that grounds it when pressed.
44
 
 
45
 
  Implementation details:
46
 
 
47
 
  - the timing of the drawing of the clock face is recalculated with
48
 
    every rotation of the propeller (for maximum update speed).
49
 
 
50
 
  - pressing the button cycles between display modes
51
 
 
52
 
  - holding down the button for 2 seconds enters "set time" mode. In
53
 
    this mode, the fan must be held still and the LEDs will indicate
54
 
    what number is being entered for each time digit. Pressing the
55
 
    button increments the current digit. Holding it down moves to the
56
 
    next digit (or leaves "set time" mode when there are no more). In
57
 
    order, the digits (with accepted values) are: hours-tens (0 to 2),
58
 
    hours-ones (0 to 9), minutes-tens (0 to 5), minutes-ones (0 to 9).
 
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
59
75
 
60
76
******************************************************************************/
61
77
 
62
 
 
63
 
#include <Bounce.h>
 
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"
64
85
 
65
86
//_____________________________________________________________________________
66
87
//                                                                         data
81
102
static unsigned long segment_step_sub_step = 0;
82
103
static unsigned long segment_step_sub = 0;
83
104
 
84
 
// flag to indicate that the drawing mode should be cycled to the next one
85
 
static bool inc_draw_mode = false;
86
 
 
87
 
// a bounce-managed button
88
 
static Bounce button( 3, 5 );
89
 
 
90
 
// the time
91
 
static int time_hours = 0;
92
 
static int time_minutes = 0;
93
 
static int time_seconds = 0;
94
 
 
95
 
// number of segments in a full display (rotation) is 60 (one per
96
 
// second) times the desired number of sub-divisions of a second
97
 
#define NUM_SECOND_SEGMENTS 5
98
 
#define NUM_SEGMENTS ( 60 * NUM_SECOND_SEGMENTS )
 
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 };
99
115
 
100
116
//_____________________________________________________________________________
101
117
//                                                                         code
102
118
 
103
119
 
104
 
// check for button presses
105
 
void checkButtons()
106
 
{
107
 
        // update buttons
108
 
        button.update();
109
 
 
110
 
        // notice button presses
111
 
        if( button.risingEdge() )
112
 
                inc_draw_mode = true;
113
 
}
114
 
 
115
 
 
116
 
// keep track of time
117
 
void trackTime()
118
 
{
119
 
        // previous time and any carried-over milliseconds
120
 
        static unsigned long last_time = millis();
121
 
        static unsigned long carry = 0;
122
 
 
123
 
        // how many milliseonds have elapsed since we last checked?
124
 
        unsigned long next_time = millis();
125
 
        unsigned long delta = next_time - last_time + carry;
126
 
 
127
 
        // update the previous time and carried-over milliseconds
128
 
        last_time = next_time;
129
 
        carry = delta % 1000;
130
 
 
131
 
        // add the seconds that have passed to the time
132
 
        time_seconds += delta / 1000;
133
 
        while( time_seconds >= 60 ) {
134
 
                time_seconds -= 60;
135
 
                time_minutes++;
136
 
                if( time_minutes >= 60 ) {
137
 
                        time_minutes -= 60;
138
 
                        time_hours++;
139
 
                        if( time_hours >= 24 )
140
 
                                time_hours -= 24;
 
120
// perform button events
 
121
void doButtonEvents()
 
122
{
 
123
        // loop through pending events
 
124
        while( int event = button.get_event() )
 
125
        {
 
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
 
141
147
                }
142
148
        }
143
149
}
144
150
 
145
151
 
146
 
// draw a segment for the test display
147
 
void drawNextSegment_test( bool reset )
148
 
{
149
 
        // keep track of segment
150
 
        static unsigned int segment = 0;
151
 
        if( reset ) segment = 0;
152
 
        segment++;
153
 
 
154
 
        // turn on inside and outside LEDs
155
 
        digitalWrite( 4, HIGH );
156
 
        digitalWrite( 13, HIGH );
157
 
 
158
 
        // display segment number in binary across in the inside LEDs,
159
 
        // with the LED on pin 12 showing the least-significant bit
160
 
        for( int a = 0; a < 8; a++ )
161
 
                digitalWrite( 12 - a, ( ( segment >> a ) & 1 )? HIGH : LOW );
162
 
}
163
 
 
164
 
 
165
 
// draw a segment for the time display
166
 
void drawNextSegment_time( bool reset )
167
 
{
168
 
        static unsigned int second = 0;
169
 
        static unsigned int segment = 0;
170
 
 
171
 
        // handle display reset
172
 
        if( reset ) {
173
 
                second = 0;
174
 
                segment = 0;
175
 
        }
176
 
 
177
 
        // what needs to be drawn?
178
 
        bool draw_tick = !segment && second % 5 == 0;
179
 
        bool draw_second = !segment && second == time_seconds;
180
 
        bool draw_minute = !segment && second == time_minute;
181
 
        bool draw_hour = !segment && second == time_hour;
182
 
 
183
 
        // set the LEDs
184
 
        digitalWrite( 13, HIGH );
185
 
        digitalWrite( 12, draw_tick || draw_minute );
186
 
        for( int a = 10; a <= 11; a++ )
187
 
                digitalWrite( a, draw_minute || draw_second );
188
 
        for( int a = 4; a <= 9; a++ )
189
 
                digitalWrite( 10, draw_minute | draw_second || draw_hour );
190
 
 
191
 
        // inc position
192
 
        if( ++segment >= NUM_SECOND_SEGMENTS ) {
193
 
                segment = 0;
194
 
                second++;
195
 
        }
196
 
}
197
 
 
198
 
 
199
152
// draw a display segment
200
153
void drawNextSegment( bool reset )
201
154
{
202
 
        static int draw_mode = 0;
203
 
 
204
 
        // handle mode switch requests
205
 
        if( reset && inc_draw_mode ) {
206
 
                inc_draw_mode = false;
207
 
                draw_mode++;
208
 
                if( draw_mode >= 2 )
209
 
                        draw_mode = 0;
210
 
        }
211
 
 
212
 
        // draw the segment
213
 
        switch( draw_mode ) {
214
 
        case 0: drawNextSegment_test( reset ); break;
215
 
        case 1: drawNextSegment_time( reset ); break;
216
 
        }
 
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
217
174
}
218
175
 
219
176
 
240
197
 
241
198
// wait until it is time to draw the next segment or a new pulse has
242
199
// occurred
243
 
void waitTillNextSegment( bool reset )
 
200
void waitTillEndOfSegment( bool reset )
244
201
{
245
202
        static unsigned long end_time = 0;
246
203
 
291
248
 
292
249
        // set up mode-switch button on pin 3
293
250
        pinMode( 3, INPUT );
 
251
        digitalWrite( 3, HIGH );
 
252
        static int event_times[] = { 5, 500, 4000, 0 };
 
253
        button.set_event_times( event_times );
294
254
 
295
 
        // serial comms
296
 
        Serial.begin( 9600 );
 
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();
297
260
}
298
261
 
299
262
 
303
266
        // if there has been a new pulse, we'll be resetting the display
304
267
        bool reset = new_pulse_at? true : false;
305
268
 
 
269
        // update button
 
270
        button.update();
 
271
 
306
272
        // only do this stuff at the start of a display cycle, to ensure
307
273
        // that no state changes mid-display
308
274
        if( reset )
309
275
        {
310
 
                // check buttons
311
 
                checkButtons();
 
276
                // calculate segment times
 
277
                calculateSegmentTimes();
312
278
 
313
279
                // keep track of time
314
 
                trackTime();
 
280
                Time &time = Time::get_instance();
 
281
                time.update();
 
282
 
 
283
                // perform button events
 
284
                doButtonEvents();
315
285
        }
316
286
 
317
287
        // draw this segment
318
288
        drawNextSegment( reset );
319
289
 
320
 
        // do we need to recalculate segment times?
321
 
        if( reset )
322
 
                calculateSegmentTimes();
323
 
 
324
290
        // wait till it's time to draw the next segment
325
 
        waitTillNextSegment( reset );
 
291
        waitTillEndOfSegment( reset );
326
292
}