|
1 | | -# Build |
| 1 | +# ThingPulse ESP8266 Weather Station |
2 | 2 |
|
3 | | -* Stable: [](https://travis-ci.org/squix78/esp8266-weather-station) |
4 | | -* Development: [](https://travis-ci.org/squix78/esp8266-weather-station) |
| 3 | +[](https://thingpulse.com) |
5 | 4 |
|
6 | | -# esp8266-weather-station |
7 | | -This code works best with the NodeMCU V1, 0.96" OLED display. |
8 | | -Since it is sometimes complicated to find the right parts I created a kit which contains all the parts including the connector PCB: |
9 | | -https://blog.squix.org/product/weatherstation-kit-w-white-oled |
10 | | -By buying the kit from me you are supporting future development. Thank you! |
11 | 5 |
|
12 | | -[](https://blog.squix.org/product/weatherstation-kit-w-white-oled) |
| 6 | +This code works best with the NodeMCU V2 and an 0.96" OLED display. |
| 7 | +To get you up and running in no time we created a kit which contains all the necessary parts including a custom PCB to connect display and WiFi chip: |
| 8 | +[https://thingpulse.com/product/esp8266-iot-electronics-starter-kit-weatherstation-planespotter-worldclock/](https://thingpulse.com/product/esp8266-iot-electronics-starter-kit-weatherstation-planespotter-worldclock/) |
13 | 9 |
|
| 10 | +By buying the kit from me us are supporting future development. Thank you! |
| 11 | + |
| 12 | +[](https://thingpulse.com/product/esp8266-iot-electronics-starter-kit-weatherstation-planespotter-worldclock/) |
| 13 | + |
| 14 | +### Build Status |
| 15 | + |
| 16 | +| Branch | Status | |
| 17 | +| ------------- | ------------- | |
| 18 | +| master | [](https://travis-ci.org/ThingPulse/esp8266-weather-station) | |
| 19 | +| development | [](https://travis-ci.org/ThingPulse/esp8266-weather-station) | |
14 | 20 |
|
15 | 21 | ## Arduino IDE |
16 | 22 |
|
17 | | -Make sure you use a version of the Arduino IDE which is supported by the ESP8266 platform. You can find it here: https://www.arduino.cc/en/Main/OldSoftwareReleases |
| 23 | +Make sure you use a version of the Arduino IDE which is supported by the ESP8266 platform. You can find it here: [https://www.arduino.cc/en/Main/OldSoftwareReleases](https://www.arduino.cc/en/Main/OldSoftwareReleases) |
18 | 24 |
|
19 | 25 | ## Setup Arduino IDE |
20 | 26 |
|
21 | 27 | * Install the following libraries with your Arduino Library Manager in Sketch > Include Library > Manage Libraries... |
22 | 28 |
|
23 | | - * ESP8266 Weather Station |
24 | | - * Json Streaming Parser (by Daniel Eichhorn) |
25 | | - * ESP8266 Oled Driver for SSD1306 display (by me as well). **Make sure that you use Version 3.0.0 or bigger!** |
26 | | -* Go to http://wunderground.com, create an account and get an API Key |
| 29 | +* ESP8266 Weather Station |
| 30 | +* JSON Streaming Parser by Daniel Eichhorn |
| 31 | +* ESP8266 Oled Driver for SSD1306 display by Daniel Eichhorn. **Make sure that you use Version 3.0.0 or bigger!** |
| 32 | +* Go to [https://www.wunderground.com/weather/api/](https://www.wunderground.com/weather/api/) |
| 33 | +, create an account and get an API Key |
27 | 34 | * In the Arduino IDE go to File > Examples > ESP8266 Weather Station |
28 | | - * Enter the Wunderground API Key |
29 | | - * Enter your Wifi credentials |
30 | | - * Adjust the location according to Wunderground API, e.g. Zurich, CH |
31 | | - * Adjust UTC offset |
| 35 | +* Enter the Wunderground API Key |
| 36 | +* Enter your Wifi credentials |
| 37 | +* Adjust the location according to Wunderground API, e.g. Zurich, CH |
| 38 | +* Adjust UTC offset |
32 | 39 |
|
33 | 40 | ## Setup for PlatformIO |
34 | 41 |
|
35 | 42 | If you are using the PlatformIO environment for building |
36 | | - * choose one of the available IDE integration or the Atom based IDE |
37 | | - * install libraries 561, 562 and 563 with "platformio lib install" |
38 | | - * adapt the WeatherStationDemo.ino file to your needs (see details above) |
| 43 | + |
| 44 | +* choose one of the available IDE integration or the Atom based IDE |
| 45 | +* install libraries 561, 562 and 563 with "platformio lib install" |
| 46 | +* adapt the [WeatherStationDemo.ino](examples/WeatherStationDemo/WeatherStationDemo.ino) file to your needs (see details above) |
39 | 47 |
|
40 | 48 |
|
41 | 49 | ## Upgrade |
42 | 50 |
|
43 | | -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 here: [Upgrade Guide](https://github.com/squix78/esp8266-oled-ssd1306/blob/master/UPGRADE-3.0.md) |
| 51 | +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](https://github.com/ThingPulse/esp8266-oled-ssd1306/blob/master/UPGRADE-3.0.md) |
44 | 52 |
|
45 | 53 | ## Available Modules |
46 | 54 | * **TimeClient**: simple class which uses the header date and time to set the clock |
47 | 55 | * **NTPClient**: a NTP based time class written by Fabrice Weinberg |
48 | 56 | * **WundergroundClient**: fetches current weather and forecast from wunderground.com |
49 | | -* **ThingspeakClient**: fetches data from Thingspeak which you might have collected with another sensor node and posted there. I use this to measure outdoor temperature and humidity and show it on the WeatherStation with a ClimateNode: https://shop.squix.ch/index.php/esp8266/climatenode.html |
| 57 | +* **ThingspeakClient**: fetches data from Thingspeak which you might have collected with another sensor node and posted there. |
50 | 58 |
|
51 | 59 | ## Why Weather Station as a library? |
52 | 60 |
|
|
0 commit comments