Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating README now that the project is finished.
- Loading branch information
Konstantin Gredeskoul
committed
Dec 25, 2014
1 parent
465fa35
commit 7a25134
Showing
7 changed files
with
83 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,22 @@ | ||
The MIT License (MIT) | ||
Copyright (c) 2015 Konstantin Gredeskoul | ||
|
||
Copyright (c) 2014 Konstantin Gredeskoul | ||
MIT License | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
Permission is hereby granted, free of charge, to any person obtaining | ||
a copy of this software and associated documentation files (the | ||
"Software"), to deal in the Software without restriction, including | ||
without limitation the rights to use, copy, modify, merge, publish, | ||
distribute, sublicense, and/or sell copies of the Software, and to | ||
permit persons to whom the Software is furnished to do so, subject to | ||
the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
The above copyright notice and this permission notice shall be | ||
included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,57 @@ | ||
WallClock | ||
========= | ||
|
||
Digital clock with rotary encoder button used to set time. | ||
Teensy-based digital clock with rotary encoder button used to set time, and neo-pixels for the fun of it :) | ||
|
||
Yes, teensy is probably an overkill for this project, but it does provide some interesting options in the future. | ||
|
||
Overview | ||
============= | ||
|
||
The clock is equipped with: | ||
|
||
* light sensor (beneath the rotary knob) | ||
* rotary knob with a built-in button functionality | ||
* neo pixels | ||
* Adafruit 7-segment I2C display | ||
|
||
![Clock Front View](images/clock_front.jpg) | ||
|
||
Functionality | ||
============= | ||
|
||
When the switch turns on, the clock is on. The time is stored on Teensy backed by a 3.3V battery, and uses a crystal soldered on the bottom of Teensy. | ||
|
||
When the clock is running, you can: | ||
* single click rotary knob turns on/off neo pixel strip | ||
* double click rotary knob turns off/on 7-segment display | ||
* moving rotary knob in this mode changes the brightness. There are 16 total values for brightness, from 0 to 15. | ||
* press and hold enters the menu to set the time | ||
* Once in the menu setup, rotating the knob changes the current hour. When done, click the knob once. | ||
* If during either hour or minutes setup you rather cancel this process, double click the button. | ||
* Now change the minutes, and when ready click the knob once. | ||
* Now the time will be set and saved, and configuration mode is finished. | ||
|
||
Libraries | ||
========= | ||
Supplied with Teensy: | ||
* Wire | ||
* DS1307RTC | ||
* Adafruit_GFX | ||
* Time | ||
|
||
Additional dependencies: | ||
* [LiquidCrystal_I2C](https://github.com/fdebrabander/Arduino-LiquidCrystal-I2C-library) (only needed for a debug LCD 4x20 screen, which can be disabled with a macro define) | ||
* [Adafruit_LEDBackpack](https://github.com/adafruit/Adafruit-LED-Backpack-Library) | ||
* [RotaryEncoderWithButton](https://github.com/kigster/kiguino/tree/master/arduino/libraries/RotaryEncoderWithButton) | ||
* [OneButton](https://github.com/mathertel/OneButton) | ||
|
||
![Clock Top View](images/clock_top_.jpg) | ||
|
||
|
||
Author | ||
====== | ||
|
||
(c) 2015 Konstantin Gredeskoul, https://github.com/kigster | ||
|
||
Distributed under MIT license, see [LICENSE](LICENSE). |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.