From 6d599a58510ca8976e3f7af3fb867dc41743f095 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 08:09:55 -0400
Subject: [PATCH 14/22] Added License Badge
---
README.md | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 21595b3..efee1a3 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,19 @@
+
+
+
+
+
+
**Development** [![Badge Master]][Actions]
**Master** [![Badge Master]][Actions]
-
+
---
From c30bbd7bb5804f8ee7c917426ff2e2e46f8e609f Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 09:47:04 -0400
Subject: [PATCH 15/22] Formatted Changelog
---
Documentation/Changelog.md | 61 +++++++++++++++++++++++++++++++++-----
README.md | 3 --
2 files changed, 54 insertions(+), 10 deletions(-)
diff --git a/Documentation/Changelog.md b/Documentation/Changelog.md
index ea0a46c..a730d75 100644
--- a/Documentation/Changelog.md
+++ b/Documentation/Changelog.md
@@ -1,13 +1,60 @@
-## Upgrade Notes
-**Version 2, January 2020, removes WU support, see below**
+# Changelog
-**Replace Wunderground with OpenWeatherMap as weather data provider**
+## Version 2
-The weather information provider we used so far (Wunderground) [recently stopped their free tier][No Free] without previous notice on May 15, 2018. This release adds support for a new provider with a free tier for weather information: OpenWeatherMap.com. The basic demo (WeatherStationDemo) has been adapted to use this new API through the OpenWeatherMapCurrent and OpenWeatherMapForecast REST clients.
+**When:** `January 2020`
+**What:** `Removes Wunderground Support`
-Sadly OpenWeatherMap provides less information than Wunderground did (or still does). If you are missing attributes in the response documents then please [contact the OpenWeatherMap team][OpenWeatherMap].
+
-**ESP8266 OLED Library upgrade**
+### Wunderground ➞ OpenWeatherMap
-The ESP8266 OLED Library changed a lot with the latest release of version 3.0.0. We fixed many bugs and improved performance and changed the API a little bit. This means that you might have to adapt your Weather Station Code if you created it using the older 2.x.x version of the library. Either compare your code to the updated WeatherStationDemo or read through the [upgrade guide][Upgrade]
\ No newline at end of file
+*Weather Data Provider Replacement*
+
+
+**Wunderground**, the weather information provider
+we used so far, [stopped their free tier][No Free] without notice
+on `May 15, 2018` .
+
+This release adds support for `OpenWeatherMap.com` , an
+alternate provider with a free tier for weather information.
+
+The `WeatherStationDemo` has been adapted to use
+this new **API** through the `OpenWeatherMapCurrent`
+and `OpenWeatherMapForecast` **REST** clients.
+
+
+
+*Sadly **OpenWeatherMap** provides less*
+*information than **Wunderground** does.*
+
+
+
+If you are missing attributes in the response docs
+then please contact the **[OpenWeatherMap]** team.
+
+
+
+### OLED Library Upgrade
+
+The **ESP8266 OLED Library** changed
+a lot with the latest release of `v3.0.0` .
+
+We fixed many bugs, changed the **API**
+a little bit and improved performance.
+
+This means that you might have to adapt
+your ***Weather Station Code*** if you created
+it using older `2.x.x` versions.
+
+Either compare your code to the updated
+**WeatherStationDemo** or read the guide
+on how to **[Upgrade]**.
+
+
+
+
+[Upgrade]: https://github.com/ThingPulse/esp8266-oled-ssd1306/blob/master/UPGRADE-3.0.md
+[OpenWeatherMap]: https://openweathermap.desk.com/customer/portal/emails/new
+[No Free]: https://thingpulse.com/weather-underground-no-longer-providing-free-api-keys/
\ No newline at end of file
diff --git a/README.md b/README.md
index efee1a3..8eea88b 100644
--- a/README.md
+++ b/README.md
@@ -118,7 +118,6 @@ declaration for what this means.
[Modules]: Documentation/Modules.md
[Design]: Documentation/Design.md
-[Upgrade]: https://github.com/ThingPulse/esp8266-oled-ssd1306/blob/master/UPGRADE-3.0.md
[Actions]: https://github.com/ThingPulse/esp8266-weather-station/actions
[Logo]: https://thingpulse.com/assets/ThingPulse-w300.svg
@@ -134,7 +133,5 @@ declaration for what this means.
[Example]: examples/WeatherStationDemo/WeatherStationDemo.ino
[Wunderground Code]: https://thingpulse.com/hello-openweathermap-bye-bye-wunderground/
-[OpenWeatherMap]: https://openweathermap.desk.com/customer/portal/emails/new
-[No Free]: https://thingpulse.com/weather-underground-no-longer-providing-free-api-keys/
[Alonso]: http://conga.oan.es/~alonso/doku.php?id=blog:sun_moon_position
From 6d014ba10d435e65d3b789ae01c75d3eddf35c27 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 09:49:40 -0400
Subject: [PATCH 16/22] Adjusted Spacing
---
README.md | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 8eea88b..deaea3d 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,7 @@
![]()
Date: Sat, 9 Apr 2022 09:51:29 -0400
Subject: [PATCH 17/22] Adjusted Style
---
Documentation/Changelog.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/Documentation/Changelog.md b/Documentation/Changelog.md
index a730d75..137347e 100644
--- a/Documentation/Changelog.md
+++ b/Documentation/Changelog.md
@@ -1,10 +1,12 @@
# Changelog
+
+
## Version 2
**When:** `January 2020`
-**What:** `Removes Wunderground Support`
+**What:** `Removes Wunderground Support`
@@ -12,6 +14,7 @@
*Weather Data Provider Replacement*
+
**Wunderground**, the weather information provider
we used so far, [stopped their free tier][No Free] without notice
@@ -34,10 +37,13 @@ and `OpenWeatherMapForecast` **REST** clients.
If you are missing attributes in the response docs
then please contact the **[OpenWeatherMap]** team.
+
### OLED Library Upgrade
+
+
The **ESP8266 OLED Library** changed
a lot with the latest release of `v3.0.0` .
@@ -57,4 +63,4 @@ on how to **[Upgrade]**.
[Upgrade]: https://github.com/ThingPulse/esp8266-oled-ssd1306/blob/master/UPGRADE-3.0.md
[OpenWeatherMap]: https://openweathermap.desk.com/customer/portal/emails/new
-[No Free]: https://thingpulse.com/weather-underground-no-longer-providing-free-api-keys/
\ No newline at end of file
+[No Free]: https://thingpulse.com/weather-underground-no-longer-providing-free-api-keys/
From b61d582ba71b29144e8fc252194e09fbfc45f081 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 10:02:20 -0400
Subject: [PATCH 18/22] Formatted Design
---
Documentation/Design.md | 31 +++++++++++++++++++++++++++----
1 file changed, 27 insertions(+), 4 deletions(-)
diff --git a/Documentation/Design.md b/Documentation/Design.md
index f62558c..bf4c0e6 100644
--- a/Documentation/Design.md
+++ b/Documentation/Design.md
@@ -1,6 +1,29 @@
-## Why Weather Station as a library?
+## Why A Library?
-I realized that more and more the Weather Station was becoming a general framework for displaying data over WiFi to one of these pretty displays. But everyone would have different ways or sources for data and having the important part of the library would rather be the classes which fetch the data then the main class.
-So if you write data fetchers which might be of interest to others please contact me to integrate them here or offer your code as extension library yourself and call it something like esp8266-weather-station-
.
-We will gladly list it here as third party library...
+I realized that more and more the **Weather Station**
+was becoming a general framework for displaying
+data over **WiFi** to one of these pretty displays.
+
+
+
+#### What Was Needed
+
+However everyone would have different ways or
+sources for data and as such, the important part
+of the library would rather be the classes that
+fetch the data, than the main class.
+
+
+
+#### Data Fetchers
+
+In case you wrote a data fetcher that might be
+of interest to others and you would like it to be
+integrated in this library, simply contact me.
+
+Otherwise you might also want to offer your code
+as extension library yourself and call it something
+like `ESP8266-Weather-Station-< Your Service >`
+
+***We will gladly list it as third party library.***
From 87a4fc79f363c1939a6cfcb9cde3289bdf143086 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 10:14:34 -0400
Subject: [PATCH 19/22] Formatted Modules List
---
Documentation/Modules.md | 76 +++++++++++++++++++++++++++++++++++-----
1 file changed, 68 insertions(+), 8 deletions(-)
diff --git a/Documentation/Modules.md b/Documentation/Modules.md
index be3acf0..68ddb2b 100644
--- a/Documentation/Modules.md
+++ b/Documentation/Modules.md
@@ -1,8 +1,68 @@
-## Available Modules
-* **Time Client**: simple class which uses the header date and time to set the clock
-* **NTP Client**: a NTP based time class written by Fabrice Weinberg
-* **OpenWeatherMap Client**: A REST client for the OpenWeatherMap.com service, providing weather information
-* **Aeris Client**: Client for the service provided by aerisweather.com. Fully functional initial version. After the Wunderground incident (see [upgrade notes](#upgrade-notes)) we first targeted Aeris before we settled with OpenWeatherMap. This code is unmaintained but will remain part of this library for the time being.
-* **Thingspeak Client**: fetches data from Thingspeak which you might have collected with another sensor node and posted there.
-* **Astronomy**: algorithms to calculate current lunar phase and illumination.
-* **SunMoonCalc**: a calculator for sun and moon properties for a given date & time and location. This implementation is port of a [Java class by T. Alonso Albi][Alonso] from OAN (Spain).
\ No newline at end of file
+
+# Modules
+
+*Modules Available In This Library*
+
+
+
+### Time Client
+
+A simple class that uses the header
+date and time to set the clock.
+
+
+
+### NTP Client
+
+A **NTP** based time class written by `Fabrice Weinberg`.
+
+
+
+### OpenWeatherMap Client
+
+A **REST** client for the `OpenWeatherMap.com`
+service, providing weather information.
+
+
+
+### Aeris Client
+
+A client for the service provided by `aerisweather.com`.
+
+*Fully functional initial version.*
+
+After the [Wunderground Incident][Changelog] we first targeted
+**Aeris** before we settled with **OpenWeatherMap**.
+
+*This code is **unmaintained** but will,*
+*for now, remain part of this library.*
+
+
+
+### Thingspeak Client
+
+Fetches data from **Thingspeak** which you might have
+collected with another sensor node and posted there.
+
+
+
+### Astronomy
+
+Algorithms to calculate current lunar phase and illumination.
+
+
+
+### SunMoonCalc
+
+A calculator for sun / moon properties
+for a given date, time and location.
+
+*This implementation is port of a* ***Java***
+*class by [T. Alonso Albi] from :es: **OAN**.*
+
+
+
+
+[Changelog]: Changelog.md
+
+[T. Alonso Albi]: http://conga.oan.es/~alonso/doku.php?id=blog:sun_moon_position
From eca0570802c5b0e2e56401c92a60c2cbf20afa02 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 10:15:41 -0400
Subject: [PATCH 20/22] Adjusted Style
---
Documentation/Modules.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/Modules.md b/Documentation/Modules.md
index 68ddb2b..9f35e47 100644
--- a/Documentation/Modules.md
+++ b/Documentation/Modules.md
@@ -5,27 +5,27 @@
-### Time Client
+## Time Client
A simple class that uses the header
date and time to set the clock.
-### NTP Client
+## NTP Client
A **NTP** based time class written by `Fabrice Weinberg`.
-### OpenWeatherMap Client
+## OpenWeatherMap Client
A **REST** client for the `OpenWeatherMap.com`
service, providing weather information.
-### Aeris Client
+## Aeris Client
A client for the service provided by `aerisweather.com`.
@@ -39,20 +39,20 @@ After the [Wunderground Incident][Changelog] we first targeted
-### Thingspeak Client
+## Thingspeak Client
Fetches data from **Thingspeak** which you might have
collected with another sensor node and posted there.
-### Astronomy
+## Astronomy
Algorithms to calculate current lunar phase and illumination.
-### SunMoonCalc
+## SunMoonCalc
A calculator for sun / moon properties
for a given date, time and location.
From 395a994f1c99ba505dd220bbbfee43ffcac0c3cf Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 10:33:12 -0400
Subject: [PATCH 21/22] Formatted Install Instructions
---
Documentation/Install.md | 99 ++++++++++++++++++++++++++++++++--------
README.md | 6 ---
2 files changed, 80 insertions(+), 25 deletions(-)
diff --git a/Documentation/Install.md b/Documentation/Install.md
index b2740b7..d4e9264 100644
--- a/Documentation/Install.md
+++ b/Documentation/Install.md
@@ -1,26 +1,87 @@
-## Install and configure Arduino IDE
-Make sure you use a version of the Arduino IDE which is supported by the ESP8266 platform. Follow the [tutorial on our documentation platform][Tutorial].
+# Installation
-## Install libraries in Arduino IDE
+## Arduino IDE
-Install the following libraries with your Arduino Library Manager in `Sketch` > `Include Library` > `Manage Libraries...`
-* ESP8266 Weather Station
-* JSON Streaming Parser by Daniel Eichhorn
-* ESP8266 OLED Driver for SSD1306 display by Daniel Eichhorn. **Use Version 3.0.0 or higher!**
+### Setup
-## Prepare the software
-* [Create an API Key][API Key] for OpenWeatherMap
-* In the Arduino IDE go to `File` > `Examples` > `ESP8266 Weather Station` > `Weather Station Demo`
-* Enter the OpenWeatherMap API Key
-* Enter your WiFi credentials
-* Adjust the location according to OpenWeatherMap API, e.g. Zurich, CH
-* Adjust UTC offset
+Make sure you use a version of the **Arduino IDE**
+which is supported by the **ESP8266** platform.
-## Setup for PlatformIO
+Please follow the **[Tutorial]** on our website.
-If you are using the PlatformIO environment for building
+
+
+### Libraries
+
+Please install the following libraries:
+
+- `ESP8266 Weather Station`
+- `JSON Streaming Parser by Daniel Eichhorn`
+- `ESP8266 OLED Driver for SSD1306 display by Daniel Eichhorn`
+
+ *Please use `v3.0.0+`*
+
+##### How To
+
+**Sketch**
+ › **Include Library**
+ › **Manage Libraries**
+
+
+
+### Preparation
+
+1. *[Create An API Key][API Key]* for **OpenWeatherMap**.
+
+2. Open the demo.
+
+ **File**
+ › **Examples**
+ › **ESP8266 Weather Station**
+ › **Weather Station Demo**
+
+3. Insert the **OpenWeatherMap API Key**.
+
+4. Insert your **WiFi Credentials**.
+
+5. Adjust the location according to **OpenWeatherMap**.
+
+ ↳ `Zurich, CH`
+
+6. Adjust the **UTC** offset.
+
+
+
+
+---
+
+
+
+## PlatformIO
+
+### Setup
+
+1. Choose one of the available IDE integration or the Atom based IDE.
+
+2. Install libraries:
+ - `561`
+ - `562`
+ - `563`
+
+ With:
+
+ ```sh
+ platformio lib install
+ ```
+
+3. Adapt the [`WeatherStationDemo.ino`][Example] file to your
+ needs as show in the **Arduino** preparations.
+
+
+
+
+[Tutorial]: https://docs.thingpulse.com/how-tos/Arduino-IDE-for-ESP8266/
+[API Key]: https://docs.thingpulse.com/how-tos/openweathermap-key/
+[Example]: examples/WeatherStationDemo/WeatherStationDemo.ino
-* choose one of the available IDE integration or the Atom based IDE
-* install libraries 561, 562 and 563 with "platformio lib install"
-* adapt the [WeatherStationDemo.ino][Example] file to your needs (see details above)
diff --git a/README.md b/README.md
index deaea3d..a1c6d7d 100644
--- a/README.md
+++ b/README.md
@@ -120,17 +120,11 @@ declaration for what this means.
[Actions]: https://github.com/ThingPulse/esp8266-weather-station/actions
[Logo]: https://thingpulse.com/assets/ThingPulse-w300.svg
-[Tutorial]: https://docs.thingpulse.com/how-tos/Arduino-IDE-for-ESP8266/
-[API Key]: https://docs.thingpulse.com/how-tos/openweathermap-key/
-
[Commitment]: https://thingpulse.com/about/open-source-commitment/
[Website]: https://thingpulse.com
[Shop]: https://thingpulse.com/shop/
[Kit]: https://thingpulse.com/product/esp8266-iot-electronics-starter-kit-weatherstation-planespotter-worldclock/
-[Example]: examples/WeatherStationDemo/WeatherStationDemo.ino
-
[Wunderground Code]: https://thingpulse.com/hello-openweathermap-bye-bye-wunderground/
-[Alonso]: http://conga.oan.es/~alonso/doku.php?id=blog:sun_moon_position
From 42c6fbb18b86e7f856fdaba8c5d1908eefa50c41 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 9 Apr 2022 10:34:29 -0400
Subject: [PATCH 22/22] Adjusted Spacing
---
Documentation/Install.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/Install.md b/Documentation/Install.md
index d4e9264..b91433d 100644
--- a/Documentation/Install.md
+++ b/Documentation/Install.md
@@ -1,6 +1,8 @@
# Installation
+
+
## Arduino IDE
### Setup
-
-This code works best with the **NodeMCU V2 ESP8266** module and an `0.96"` **OLED** display.
-To get you up and running in no time we created a kit which contains all the necessary parts:
-[Kit]
+This library works best with the **NodeMCU V2 ESP8266**