/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
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 "button.h"
 
79
#include "config.h"
 
80
#include "time.h"
 
81
#include "mode_switcher.h"
 
82
#include "drawer.h"
64
83
 
65
84
//_____________________________________________________________________________
66
85
//                                                                         data
81
100
static unsigned long segment_step_sub_step = 0;
82
101
static unsigned long segment_step_sub = 0;
83
102
 
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 )
 
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;
99
111
 
100
112
//_____________________________________________________________________________
101
113
//                                                                         code
105
117
void checkButtons()
106
118
{
107
119
        // 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;
141
 
                }
142
 
        }
143
 
}
144
 
 
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++;
 
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;
195
135
        }
196
136
}
197
137
 
199
139
// draw a display segment
200
140
void drawNextSegment( bool reset )
201
141
{
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
 
        }
 
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
217
161
}
218
162
 
219
163
 
291
235
 
292
236
        // set up mode-switch button on pin 3
293
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 );
294
242
 
295
243
        // serial comms
296
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();
297
250
}
298
251
 
299
252
 
311
264
                checkButtons();
312
265
 
313
266
                // keep track of time
314
 
                trackTime();
 
267
                Time &time = Time::get_instance();
 
268
                time.update();
315
269
        }
316
270
 
317
271
        // draw this segment