FabLabRothenburg · jalr · Dec 21, 2018
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 .*.swp
 *.o
+.pio
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+# WordClock
+## Hardware
+Take a look inside the [hardware](hardware/) directory.
+
+## Software
+you have two options to build this software:
+1. Using Arduino IDE
+2. Using platformio
+
+## Arduino IDE
+
+### Adding ESP8266 Board
+If you want to use ESP8266 hardware you first need to do add it to Arduino.
+* Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is on the [Arduino website](https://www.arduino.cc/en/main/software).
+* Start Arduino and open the Preferences window.
+* Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into the *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
+* Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
+
+### Installing the required libraries
+Please refer to the [platformio configuration](platformio.ini) for a list of required libraries.
+
+## platformio
+* [Install platformio](https://docs.platformio.org/en/latest/installation.html)
+* To build this project for your target, such as D1 Mini run:
+
+```
+pio run -e d1_mini
+```
+
+* To upload the firmware to your Word Clock, run:
+
+```
+pio run -e d1_mini -t upload
+```
diff --git a/WordClock.svg → hardware/WordClock.svg b/WordClock.svg → hardware/WordClock.svg
diff --git a/platformio.ini b/platformio.ini
@@ -0,0 +1,15 @@
+[platformio]
+src_dir = wordClock
+
+[env:d1_mini]
+platform = espressif8266
+board = d1_mini
+framework = arduino
+upload_speed = 115200
+
+lib_deps =
+  Adafruit NeoPixel@1.3.2
+  Time@1.5
+  Timezone@1.2.2
+  PubSubClient@2.7
+
diff --git a/DisplayDriver10x11Clock.cpp → wordClock/DisplayDriver10x11Clock.cpp b/DisplayDriver10x11Clock.cpp → wordClock/DisplayDriver10x11Clock.cpp
diff --git a/DisplayDriver10x11Clock.h → wordClock/DisplayDriver10x11Clock.h b/DisplayDriver10x11Clock.h → wordClock/DisplayDriver10x11Clock.h
diff --git a/DisplayDriverFablabNeaClock.cpp → wordClock/DisplayDriverFablabNeaClock.cpp b/DisplayDriverFablabNeaClock.cpp → wordClock/DisplayDriverFablabNeaClock.cpp
diff --git a/DisplayDriverFablabNeaClock.h → wordClock/DisplayDriverFablabNeaClock.h b/DisplayDriverFablabNeaClock.h → wordClock/DisplayDriverFablabNeaClock.h
diff --git a/DisplayDriverFrickelClock.cpp → wordClock/DisplayDriverFrickelClock.cpp b/DisplayDriverFrickelClock.cpp → wordClock/DisplayDriverFrickelClock.cpp
diff --git a/DisplayDriverFrickelClock.h → wordClock/DisplayDriverFrickelClock.h b/DisplayDriverFrickelClock.h → wordClock/DisplayDriverFrickelClock.h
diff --git a/DiyHueController.cpp → wordClock/DiyHueController.cpp b/DiyHueController.cpp → wordClock/DiyHueController.cpp
diff --git a/DiyHueController.h → wordClock/DiyHueController.h b/DiyHueController.h → wordClock/DiyHueController.h
diff --git a/FallingStarAnimator.cpp → wordClock/FallingStarAnimator.cpp b/FallingStarAnimator.cpp → wordClock/FallingStarAnimator.cpp
diff --git a/FallingStarAnimator.h → wordClock/FallingStarAnimator.h b/FallingStarAnimator.h → wordClock/FallingStarAnimator.h
diff --git a/HttpContent.h → wordClock/HttpContent.h b/HttpContent.h → wordClock/HttpContent.h
diff --git a/HttpController.cpp → wordClock/HttpController.cpp b/HttpController.cpp → wordClock/HttpController.cpp
diff --git a/HttpController.h → wordClock/HttpController.h b/HttpController.h → wordClock/HttpController.h
diff --git a/IAnimator.h → wordClock/IAnimator.h b/IAnimator.h → wordClock/IAnimator.h
diff --git a/IColorControllable.h → wordClock/IColorControllable.h b/IColorControllable.h → wordClock/IColorControllable.h
diff --git a/IDisplayDriver.h → wordClock/IDisplayDriver.h b/IDisplayDriver.h → wordClock/IDisplayDriver.h
diff --git a/IWordFactoryFrankenClock.h → wordClock/IWordFactoryFrankenClock.h b/IWordFactoryFrankenClock.h → wordClock/IWordFactoryFrankenClock.h
diff --git a/IWordingStrategy.h → wordClock/IWordingStrategy.h b/IWordingStrategy.h → wordClock/IWordingStrategy.h
diff --git a/IncrementalAnimator.cpp → wordClock/IncrementalAnimator.cpp b/IncrementalAnimator.cpp → wordClock/IncrementalAnimator.cpp
diff --git a/IncrementalAnimator.h → wordClock/IncrementalAnimator.h b/IncrementalAnimator.h → wordClock/IncrementalAnimator.h
diff --git a/MockWordClockScene.cpp → wordClock/MockWordClockScene.cpp b/MockWordClockScene.cpp → wordClock/MockWordClockScene.cpp
diff --git a/MockWordClockScene.h → wordClock/MockWordClockScene.h b/MockWordClockScene.h → wordClock/MockWordClockScene.h
diff --git a/MqttController.cpp → wordClock/MqttController.cpp b/MqttController.cpp → wordClock/MqttController.cpp
diff --git a/MqttController.h → wordClock/MqttController.h b/MqttController.h → wordClock/MqttController.h
diff --git a/NtpClient.cpp → wordClock/NtpClient.cpp b/NtpClient.cpp → wordClock/NtpClient.cpp
diff --git a/NtpClient.h → wordClock/NtpClient.h b/NtpClient.h → wordClock/NtpClient.h
diff --git a/NullAnimator.cpp → wordClock/NullAnimator.cpp b/NullAnimator.cpp → wordClock/NullAnimator.cpp
diff --git a/NullAnimator.h → wordClock/NullAnimator.h b/NullAnimator.h → wordClock/NullAnimator.h
diff --git a/PersistentColors.cpp → wordClock/PersistentColors.cpp b/PersistentColors.cpp → wordClock/PersistentColors.cpp
diff --git a/PersistentColors.h → wordClock/PersistentColors.h b/PersistentColors.h → wordClock/PersistentColors.h
diff --git a/PersistentStorage.cpp → wordClock/PersistentStorage.cpp b/PersistentStorage.cpp → wordClock/PersistentStorage.cpp
diff --git a/PersistentStorage.h → wordClock/PersistentStorage.h b/PersistentStorage.h → wordClock/PersistentStorage.h
diff --git a/Word.cpp → wordClock/Word.cpp b/Word.cpp → wordClock/Word.cpp
diff --git a/Word.h → wordClock/Word.h b/Word.h → wordClock/Word.h
diff --git a/WordClockScene.cpp → wordClock/WordClockScene.cpp b/WordClockScene.cpp → wordClock/WordClockScene.cpp
diff --git a/WordClockScene.h → wordClock/WordClockScene.h b/WordClockScene.h → wordClock/WordClockScene.h
diff --git a/WordFactoryEnglish10x11Clock.cpp → wordClock/WordFactoryEnglish10x11Clock.cpp b/WordFactoryEnglish10x11Clock.cpp → wordClock/WordFactoryEnglish10x11Clock.cpp
diff --git a/WordFactoryEnglish10x11Clock.h → wordClock/WordFactoryEnglish10x11Clock.h b/WordFactoryEnglish10x11Clock.h → wordClock/WordFactoryEnglish10x11Clock.h
diff --git a/WordFactoryFrankenClock.cpp → wordClock/WordFactoryFrankenClock.cpp b/WordFactoryFrankenClock.cpp → wordClock/WordFactoryFrankenClock.cpp
diff --git a/WordFactoryFrankenClock.h → wordClock/WordFactoryFrankenClock.h b/WordFactoryFrankenClock.h → wordClock/WordFactoryFrankenClock.h
diff --git a/WordFactoryFrickelClock.cpp → wordClock/WordFactoryFrickelClock.cpp b/WordFactoryFrickelClock.cpp → wordClock/WordFactoryFrickelClock.cpp
diff --git a/WordFactoryFrickelClock.h → wordClock/WordFactoryFrickelClock.h b/WordFactoryFrickelClock.h → wordClock/WordFactoryFrickelClock.h
diff --git a/WordFactoryGermanV2Clock.cpp → wordClock/WordFactoryGermanV2Clock.cpp b/WordFactoryGermanV2Clock.cpp → wordClock/WordFactoryGermanV2Clock.cpp
diff --git a/WordFactoryGermanV2Clock.h → wordClock/WordFactoryGermanV2Clock.h b/WordFactoryGermanV2Clock.h → wordClock/WordFactoryGermanV2Clock.h
diff --git a/WordFactorySchwabenClock.cpp → wordClock/WordFactorySchwabenClock.cpp b/WordFactorySchwabenClock.cpp → wordClock/WordFactorySchwabenClock.cpp
diff --git a/WordFactorySchwabenClock.h → wordClock/WordFactorySchwabenClock.h b/WordFactorySchwabenClock.h → wordClock/WordFactorySchwabenClock.h
diff --git a/WordList.cpp → wordClock/WordList.cpp b/WordList.cpp → wordClock/WordList.cpp
diff --git a/WordList.h → wordClock/WordList.h b/WordList.h → wordClock/WordList.h
diff --git a/WordingStrategyEnglish.cpp → wordClock/WordingStrategyEnglish.cpp b/WordingStrategyEnglish.cpp → wordClock/WordingStrategyEnglish.cpp
diff --git a/WordingStrategyEnglish.h → wordClock/WordingStrategyEnglish.h b/WordingStrategyEnglish.h → wordClock/WordingStrategyEnglish.h
diff --git a/WordingStrategyFranken.cpp → wordClock/WordingStrategyFranken.cpp b/WordingStrategyFranken.cpp → wordClock/WordingStrategyFranken.cpp
diff --git a/WordingStrategyFranken.h → wordClock/WordingStrategyFranken.h b/WordingStrategyFranken.h → wordClock/WordingStrategyFranken.h
diff --git a/WordingStrategySchwaben.cpp → wordClock/WordingStrategySchwaben.cpp b/WordingStrategySchwaben.cpp → wordClock/WordingStrategySchwaben.cpp
diff --git a/WordingStrategySchwaben.h → wordClock/WordingStrategySchwaben.h b/WordingStrategySchwaben.h → wordClock/WordingStrategySchwaben.h
diff --git a/WordingStrategyStesie.cpp → wordClock/WordingStrategyStesie.cpp b/WordingStrategyStesie.cpp → wordClock/WordingStrategyStesie.cpp
diff --git a/WordingStrategyStesie.h → wordClock/WordingStrategyStesie.h b/WordingStrategyStesie.h → wordClock/WordingStrategyStesie.h
diff --git a/WordingStrategyWest.cpp → wordClock/WordingStrategyWest.cpp b/WordingStrategyWest.cpp → wordClock/WordingStrategyWest.cpp
diff --git a/WordingStrategyWest.h → wordClock/WordingStrategyWest.h b/WordingStrategyWest.h → wordClock/WordingStrategyWest.h
diff --git a/wordClock.ino → wordClock/wordClock.ino b/wordClock.ino → wordClock/wordClock.ino
-Original file line number
+Diff line change
@@ -1,2 +1,3 @@
     .*.swp
     *.o
+    .pio