From ed139ecabee77f97196d674def685b70b6dea741 Mon Sep 17 00:00:00 2001 From: Nicolas Schodet Date: Fri, 5 Jul 2019 23:07:42 +0200 Subject: Add readme file --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ saved_config_template.lua | 22 ++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 README.md create mode 100644 saved_config_template.lua diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f084eb --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +My Own Clocks +============= + +This repository hosts source files for two clocks I use at home. + +The first one, `salon`, is an Adafruit Feather HUZZAH with a FeatherWing +7 segments display. + +The second one, `chambre`, is also an Adafruit Feather HUZZAH, but with the +OLED FeatherWing. I use the buttons to control a Philips Hue light bulb. It +also light up the bulb in the morning. + +They both run nodemcu firmware. + +The clocks use NTP to keep the time, once every day. + +Configuration must be written in `saved_config.lua`, a template is provided in +`saved_config_template.lua`. + +UNLICENCE +--------- + +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +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 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. + +For more information, please refer to diff --git a/saved_config_template.lua b/saved_config_template.lua new file mode 100644 index 0000000..5ba5ac8 --- /dev/null +++ b/saved_config_template.lua @@ -0,0 +1,22 @@ +return { + ssid = 'MyWifiNetwork', + psk = 'AStrongPasswordReally', + hostname = 'clock-chambre', + tz_shift = 2, + alarm = true, + button = true, + hue = { + addr = '192.168.1.10', + user = 'VwI1eNe1Y4DSLimdUrs4WeOaLBqNNr9qCXI-j3LO', + light = 3, + }, + alarms = { + [1] = {}, + [2] = {active = true, hour = 7, min = 15}, + [3] = {active = true, hour = 7, min = 15}, + [4] = {active = true, hour = 8, min = 15}, + [5] = {active = true, hour = 7, min = 15}, + [6] = {active = true, hour = 7, min = 15}, + [7] = {}, + }, +} -- cgit v1.2.3