Skip to content

Commit 88fbb79

Browse files
clockspotclockspot
committed
Best-laid plans...
1 parent f855725 commit 88fbb79

File tree

1 file changed

+94
-13
lines changed

1 file changed

+94
-13
lines changed

‎README.md

Lines changed: 94 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,98 @@ featuring timekeeping by DS1307 RTC and six digits multiplexed 3x2 via two SN741
44

55
This is an alternate codebase that is very much in progress!
66

7-
## Current feature set
8-
* Normal running mode
9-
* Display shows a simple 4-digit counter, which increments when you press S5.
10-
* SETUP menu
11-
* To enter the SETUP menu, hold S5 for 5 seconds. This is a numbered menu; the small tubes show the current menu item (listed below), and the big tubes show its selected setting.
12-
* Press S5 to advance through the items; press S2/S3 to change the setting up and down.
13-
* Hold S5 to exit.
14-
15-
### SETUP menu items
16-
| No. | Name | Possible Settings |
7+
## Current instructions (WIP)
8+
9+
* Normal running mode simply shows a number (42 at startup).
10+
* To set, hold S4 'til display flashes; push/hold S2/S3 to set the number up/down; push S4 to save.
11+
12+
* To enter the *Setup* menu, hold for 3 seconds.
13+
* Shows option number on small tubes, and current setting on big tubes.
14+
* Push to cycle through options (listed below); turn to set; hold to exit.
15+
16+
| Option | Possible Settings |
1717
| --- | --- | --- |
18-
| 1 | Dimming | 0 = Normal running mode (the counter) will display at full brightness<br/>1 = Normal running mode will display dim (25% duty cycle) |
19-
| 2 | Nothing | Any number from 1 to 7. Has no effect yet. |
20-
| 3 | Nothing | Any number from 1 to 13. Has no effect yet. |
18+
| 1. Dimming | 0 = Normal running mode will display at full brightness<br/>1 = Normal running mode will display dim (25% duty cycle) |
19+
| 2. Nothing | Any number from 1 to 7. Has no effect yet. |
20+
| 3. Nothing | Any number from 1 to 13. Has no effect yet. |
21+
22+
## Todos
23+
24+
* Add hold-advance for adj buttons
25+
* Add support for rotary encoders
26+
* Add velocity
27+
* Configurable run controls
28+
* Test
29+
* Flesh out menu
30+
* Make settings save in eeprom(?)
31+
* Reintroduce Time
32+
* Make settable - if setting is opened in latter half of minute, setting value should be min+1 to make sync easy
33+
* Date
34+
* Make settable
35+
* Alarm
36+
* Make settable
37+
* Make trigger/switch, snooze, and silence
38+
* Timer
39+
* Make settable (opens to last setting)
40+
* Make run, trigger/switch, silence
41+
* Auto display reset
42+
* When on a mode other than clock or running timer, reset to clock after 5 sec
43+
* When in setting mode or setup menu, exit without saving after 120 seconds
44+
* "Maybe later" features
45+
* Thermometer?
46+
* Countdown to date?
47+
* Sunrise/sunset calc per lat/long?
48+
49+
## Proposed instructions
50+
51+
_These instructions are for a clock equipped with a single knob/button (rotary encoder). Instructions will vary with the controls equipped and options selected in code. If a hardware alarm switch is equipped (e.g. in a clock radio), *Alarm* will have no software switch._
52+
53+
Turn the knob to see each of the clock's functions:
54+
55+
* *Time*
56+
* Shows the current time of day. (Choose 12h or 24h format in Setup.)
57+
* To set, hold 'til display flashes; turn to set (in 24h format), and push to save. Seconds will reset to zero.
58+
* *Date*
59+
* Shows month, date, and weekday as 0=Sunday, 6=Saturday. (Choose month/date or date/month in Setup.)
60+
* To set, hold 'til display flashes; then set year, then month, then date.
61+
* *Alarm*
62+
* Shows alarm time (in 24h format) and whether the alarm is on (1) or off (0).
63+
* To turn alarm on or off, push the knob.
64+
* To set alarm, hold 'til display flashes; turn to set (in 24h format), and push to save.
65+
* When alarm goes off, push to snooze, or hold to silence until tomorrow.
66+
* *Timer*
67+
* Shows a countdown timer (or 0min 00sec when idle).
68+
* To set, hold 'til display flashes; set time (in hrs, min, sec); and press to start. Hold to cancel.
69+
* When timer goes off, push to silence.
70+
71+
Additional settings are available in the *Setup* menu.
72+
73+
* To enter *Setup*, hold for 3 seconds.
74+
* Shows option number on small tubes, and current setting on big tubes.
75+
* Push to cycle through options (listed below); turn to set; hold to exit.
76+
77+
| Option | Possible Settings |
78+
| --- | --- |
79+
| | *Display* |
80+
| 1. Time format | *12*- or *24*-hour<br/>(time display only; setting is always done in 24h) |
81+
| 2. Date display | 1 = month/date/weekday<br/>2 = date/month/weekday |
82+
| 3. Display date during time? | 0 = never<br/>1 = date instead of seconds<br/>2 = full date each minute at :30 seconds |
83+
| 4. Leading zero in hour, date, and month? | 0 = no, 1 = yes |
84+
| 5. Transition fade | 0–50 (1/100ths of a second) |
85+
| 6. Digit cycle | 0 = before midnight and/or before day-off<br/>1 = each hour at :01 minute<br/>(This helps prevent [cathode poisoning](http://www.tube-tester.com/sites/nixie/different/cathode%20poisoning/cathode-poisoning.htm).)
86+
| | *Timekeeping* |
87+
| 7. Daylight saving time | Automatically set clock 1hr forward/back at 2am local time on these dates: |
88+
| | 0 = off<br/>1 = second Sunday in March to first Sunday in November (US/CA)<br/>2 = last Sunday in March to last Sunday in October (UK/EU)<br/>3 = first Sunday in April to last Sunday in October (MX)<br/>4 = last Sunday in September to first Sunday in April (NZ)<br/>5 = first Sunday in October to first Sunday in April (AU)<br/>6 = third Sunday in October to third Sunday in February (BZ) |
89+
| 8. Hourly strike | (Non-clock-radios only)<br/>0 = off<br/>1 = beep<br/>2 = pips<br/>3 = strike<br/>4 = ship's bell<br/>(Clocks without radio/timer control only. Will not sound during day-off or night-off.) |
90+
| 9. Snooze duration | 0–60 minutes. 0 disables snooze. |
91+
| 10. Fine regulation | Adjusts clock's timekeeping in tenths of a second per week. 500 is "normal." (e.g.: 503 causes clock to run 0.3s faster per week.) |
92+
| | *Night-off mode* – Dim or shut off the tubes daily. |
93+
| 11. Brightness | 0 = normal (no change)<br/>1 = dimmed<br/>2 = shut off |
94+
| 12. Night starts at | Time of day |
95+
| 13. Night ends at | Time of day. Set to 99:99 to use the alarm time. |
96+
| | *Day-off mode* – To save tube life, shut off tubes during the day when you're not around. |
97+
| 14. Type | 0 = normal (no change)<br/>1 = office mode (shut off all day on weekends)<br/>2 = home mode (shut off during office hours |
98+
| 15. First day of work week | 0–6 (Sunday–Saturday) |
99+
| 16. Last day of work week | 0–6 (Sunday–Saturday) |
100+
| 17. Work starts at | Time of day |
101+
| 18. Work ends at | Time of day |

0 commit comments

Comments
 (0)