/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 propeller-clock/propeller-clock.pde

  • Committer: edam
  • Date: 2011-12-02 01:18:26 UTC
  • Revision ID: edam@waxworlds.org-20111202011826-uzjcdp535mlb98sl
moved kicad files in to "project" directory, which *in future projects) can hold scematics and PCB designs

Show diffs side-by-side

added added

removed removed

propeller-clock/propeller-clock.pde
1
 
/* -*- mode: c++; compile-command: "BOARD=pro5v make"; -*- */
2
1
/*
3
 
 * propeller-clock.ino
 
2
 * propeller-clock.pde
4
3
 *
5
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
4
 * Copyright (C) 2011 Tim Marston <edam@waxworlds.org>
6
5
 *
7
6
 * This file is part of propeller-clock (hereafter referred to as "this
8
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
7
 * program"). See http://ed.am/software/arduino/propeller-clock for more
9
8
 * information.
10
9
 *
11
10
 * This program is free software: you can redistribute it and/or modify
24
23
 
25
24
/******************************************************************************
26
25
 
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
 
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).
75
59
 
76
60
******************************************************************************/
77
61
 
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"
 
62
 
 
63
#include <Bounce.h>
84
64
 
85
65
//_____________________________________________________________________________
86
66
//                                                                         data
101
81
static unsigned long segment_step_sub_step = 0;
102
82
static unsigned long segment_step_sub = 0;
103
83
 
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 };
 
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 )
114
99
 
115
100
//_____________________________________________________________________________
116
101
//                                                                         code
117
102
 
118
103
 
119
 
// perform button events
120
 
void doButtonEvents()
121
 
{
122
 
        // loop through pending events
123
 
        while( int event = button.get_event() )
124
 
        {
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
 
 
 
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;
146
141
                }
147
142
        }
148
143
}
149
144
 
150
145
 
 
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
 
151
199
// draw a display segment
152
200
void drawNextSegment( bool reset )
153
201
{
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
 
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
        }
173
217
}
174
218
 
175
219
 
196
240
 
197
241
// wait until it is time to draw the next segment or a new pulse has
198
242
// occurred
199
 
void waitTillEndOfSegment( bool reset )
 
243
void waitTillNextSegment( bool reset )
200
244
{
201
245
        static unsigned long end_time = 0;
202
246
 
247
291
 
248
292
        // set up mode-switch button on pin 3
249
293
        pinMode( 3, INPUT );
250
 
        digitalWrite( 3, HIGH );
251
 
        static int event_times[] = { 5, 500, 4000, 0 };
252
 
        button.set_event_times( event_times );
253
294
 
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();
 
295
        // serial comms
 
296
        Serial.begin( 9600 );
259
297
}
260
298
 
261
299
 
265
303
        // if there has been a new pulse, we'll be resetting the display
266
304
        bool reset = new_pulse_at? true : false;
267
305
 
268
 
        // update button
269
 
        button.update();
270
 
 
271
306
        // only do this stuff at the start of a display cycle, to ensure
272
307
        // that no state changes mid-display
273
308
        if( reset )
274
309
        {
275
 
                // calculate segment times
276
 
                calculateSegmentTimes();
 
310
                // check buttons
 
311
                checkButtons();
277
312
 
278
313
                // keep track of time
279
 
                Time &time = Time::get_instance();
280
 
                time.update();
281
 
 
282
 
                // perform button events
283
 
                doButtonEvents();
 
314
                trackTime();
284
315
        }
285
316
 
286
317
        // draw this segment
287
318
        drawNextSegment( reset );
288
319
 
 
320
        // do we need to recalculate segment times?
 
321
        if( reset )
 
322
                calculateSegmentTimes();
 
323
 
289
324
        // wait till it's time to draw the next segment
290
 
        waitTillEndOfSegment( reset );
 
325
        waitTillNextSegment( reset );
291
326
}