Skip to content

Commit

Permalink
Updating README now that the project is finished.
Browse files Browse the repository at this point in the history
  • Loading branch information
Konstantin Gredeskoul committed Dec 25, 2014
1 parent 465fa35 commit 7a25134
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 24 deletions.
6 changes: 6 additions & 0 deletions .cproject
Expand Up @@ -33,6 +33,9 @@
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/LiquidCrystal_I2C2004V1}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/DS1307RTC}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/Adafruit_NeoPixel}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/Adafruit_GFX}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/Adafruit-LED-Backpack}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/LiquidCrystal_I2C}&quot;"/>
</option>
<inputType id="it.baeyens.arduino.compiler.cpp.sketch.input.679939265" name="CPP source files" superClass="it.baeyens.arduino.compiler.cpp.sketch.input"/>
</tool>
Expand All @@ -52,6 +55,9 @@
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/LiquidCrystal_I2C2004V1}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/DS1307RTC}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/Adafruit_NeoPixel}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/Adafruit_GFX}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/Adafruit-LED-Backpack}&quot;"/>
<listOptionValue builtIn="false" value="&quot;${workspace_loc:/WallClock/Libraries/LiquidCrystal_I2C}&quot;"/>
</option>
<inputType id="it.baeyens.arduino.compiler.c.sketch.input.446528251" name="C Source Files" superClass="it.baeyens.arduino.compiler.c.sketch.input"/>
</tool>
Expand Down
8 changes: 4 additions & 4 deletions .project
Expand Up @@ -27,9 +27,9 @@
</natures>
<linkedResources>
<link>
<name>Libraries/Adafruit-LED-Backpack-Library</name>
<name>Libraries/Adafruit-LED-Backpack</name>
<type>2</type>
<locationURI>ArduinoPivateLibPath/Adafruit-LED-Backpack-Library</locationURI>
<locationURI>ArduinoPivateLibPath/Adafruit-LED-Backpack</locationURI>
</link>
<link>
<name>Libraries/Adafruit_GFX</name>
Expand All @@ -52,9 +52,9 @@
<locationURI>ArduinoHardwareLibPath/Encoder</locationURI>
</link>
<link>
<name>Libraries/LiquidCrystal_I2C2004V1</name>
<name>Libraries/LiquidCrystal_I2C</name>
<type>2</type>
<locationURI>ArduinoPivateLibPath/LiquidCrystal_I2C2004V1</locationURI>
<locationURI>ArduinoPivateLibPath/LiquidCrystal_I2C</locationURI>
</link>
<link>
<name>Libraries/OneButton</name>
Expand Down
2 changes: 1 addition & 1 deletion .settings/language.settings.xml
Expand Up @@ -4,7 +4,7 @@
<extension point="org.eclipse.cdt.core.LanguageSettingsProvider">
<provider copy-of="extension" id="org.eclipse.cdt.ui.UserLanguageSettingsProvider"/>
<provider-reference id="org.eclipse.cdt.core.ReferencedProjectsLanguageSettingsProvider" ref="shared-provider"/>
<provider class="it.baeyens.arduino.toolchain.ArduinoLanguageProvider" console="false" env-hash="990019666608282571" id="it.baeyens.arduino.languageSettingsProvider" keep-relative-paths="false" name="Arduino Compiler Settings" parameter="${COMMAND} -E -P -v -dD ${INPUTS}" prefer-non-shared="true">
<provider class="it.baeyens.arduino.toolchain.ArduinoLanguageProvider" console="false" env-hash="908666933540116075" id="it.baeyens.arduino.languageSettingsProvider" keep-relative-paths="false" name="Arduino Compiler Settings" parameter="${COMMAND} -E -P -v -dD ${INPUTS}" prefer-non-shared="true">
<language-scope id="org.eclipse.cdt.core.gcc"/>
<language-scope id="org.eclipse.cdt.core.g++"/>
</provider>
Expand Down
36 changes: 18 additions & 18 deletions LICENSE
@@ -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.
55 changes: 54 additions & 1 deletion README.md
@@ -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).
Binary file added images/clock_front.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/clock_top.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7a25134

Please sign in to comment.