Skip to content

Commit 8317e36

Browse files
committed
Add open weather map api include where necessary
1 parent 2c8d7d1 commit 8317e36

File tree

4 files changed

+30
-27
lines changed

4 files changed

+30
-27
lines changed

.htaccess

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ RewriteEngine On
22

33
RewriteCond %{HTTP_HOST} ^docs\.thingpulse\.com$
44
RewriteRule ^go/create-wunderground-key$ https://www.wunderground.com/weather/api/d/pricing.html [R=301,L]
5+
RewriteRule ^go/create-openweathermap-key$ https://openweathermap.org/price [R=301,L]
56

67
<IfModule mod_deflate.c>
78
AddType x-font/woff .woff
@@ -47,4 +48,3 @@ Header set Connection keep-alive
4748
FileETag None
4849
</IfModule>
4950
</FilesMatch>
50-

docs/guides/wifi-color-display-kit.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WiFi Color Display Kit
22

3-
How to assemble and program the [ThingPulse ESP8266 WiFi Color Display Kit](https://thingpulse.com/product/esp8266-wifi-color-display-kit-2-4/).
3+
How to assemble and program the [ThingPulse ESP8266 WiFi Color Display Kit](https://thingpulse.com/product/esp8266-wifi-color-display-kit-2-4/).
44

55
---
66

@@ -22,18 +22,18 @@ If you need help at any point with the following guide do not hesitate to reach
2222
## Preparation
2323

2424
### Material inspection
25-
Here is the list of parts: display module (left), custom PCB (bottom right), WeMos D1 mini Pro (top middle) and the
25+
Here is the list of parts: display module (left), custom PCB (bottom right), WeMos D1 mini Pro (top middle) and the
2626
two pin header rows.
2727

2828
![](../img/guides/wifi-color-display-kit/1-components.jpg)
2929

3030
### Dry run assembly
3131
Stack the parts up as shown below without soldering and adjust it until it makes sense.
3232

33-
While you *could* insert the pin headers into the D1 mini like in the picture consider this: if you turned them
34-
upside down and inserted them with the longer end from underneath the D1 mini, this would allow you to later add an
35-
extension shield on top (there's a picture below). If you do not need that flexibility and want to place the pin
36-
headers like in the picture then you need to solder them to the D1 mini *first*. D1 mini-plus-headers are then
33+
While you *could* insert the pin headers into the D1 mini like in the picture consider this: if you turned them
34+
upside down and inserted them with the longer end from underneath the D1 mini, this would allow you to later add an
35+
extension shield on top (there's a picture below). If you do not need that flexibility and want to place the pin
36+
headers like in the picture then you need to solder them to the D1 mini *first*. D1 mini-plus-headers are then
3737
soldered to the PCB. Otherwise the order is reversed.
3838

3939
![](../img/guides/wifi-color-display-kit/2-dry-run-stack.jpg)
@@ -42,15 +42,15 @@ soldered to the PCB. Otherwise the order is reversed.
4242

4343
*THIS IS OPTIONAL*
4444

45-
In order to get a stack which uses the least amount of space you will want to modify the display module a bit. The
46-
SD card holder has to go, sorry. Depending on your (de)soldering skills you can either use a desoldering braid or
45+
In order to get a stack which uses the least amount of space you will want to modify the display module a bit. The
46+
SD card holder has to go, sorry. Depending on your (de)soldering skills you can either use a desoldering braid or
4747
just cut the SD card holder off with pointy cutting pliers.
4848

4949
![](../img/guides/wifi-color-display-kit/3-cut-off-sd-card-slot.jpg)
5050

5151
### Short circuit prevention
5252

53-
To prevent the D1 mini from accidentally causing a short circuit with the display board you can tape off the area
53+
To prevent the D1 mini from accidentally causing a short circuit with the display board you can tape off the area
5454
below the connector board.
5555

5656
![](../img/guides/wifi-color-display-kit/4-protect-with-tape.jpg)
@@ -59,7 +59,7 @@ below the connector board.
5959

6060
### Connect PCB and D1 mini
6161

62-
The options of which way to place the pin headers between PCB and the D1 mini were discussed earlier; hope you made
62+
The options of which way to place the pin headers between PCB and the D1 mini were discussed earlier; hope you made
6363
up your mind. To achieve what you see below the recommended steps are as follows:
6464

6565
- stack the parts up as shown
@@ -75,10 +75,10 @@ In the last step of the hardware setup you will solder the connector PCB to the
7575

7676
![](../img/guides/wifi-color-display-kit/6-solder-connector-PCB-to-display-PCB.jpg)
7777

78-
Here is a speed-up video with all the steps above. Note how PCB and display are connected in a more "space-generous"
78+
Here is a speed-up video with all the steps above. Note how PCB and display are connected in a more "space-generous"
7979
way.
8080

81-
<iframe width="688" height="387" src="https://www.youtube.com/embed/7fbGS4MjoMk?rel=0" frameborder="0"
81+
<iframe width="688" height="387" src="https://www.youtube.com/embed/7fbGS4MjoMk?rel=0" frameborder="0"
8282
allow="autoplay; encrypted-media" allowfullscreen></iframe>
8383

8484
## Development Environment Setup
@@ -97,12 +97,12 @@ allow="autoplay; encrypted-media" allowfullscreen></iframe>
9797

9898
#### Install libraries
9999

100-
The ThingPulse Weather Station Color depends on a number of other libraries. They need to be made available to the
100+
The ThingPulse Weather Station Color depends on a number of other libraries. They need to be made available to the
101101
Arduino IDE for them to be compiled and linked into the final application.
102102

103-
Go to ==Sketch== > ==Include Library...== > ==Manage Libraries...==. Then, for each library, put its name into the
104-
text field to have its metadata pulled from the internet and displayed below. Select the latest version and install
105-
it. Make sure to come back to this dialog from time to time to keep each library up to date. Also make sure that you
103+
Go to ==Sketch== > ==Include Library...== > ==Manage Libraries...==. Then, for each library, put its name into the
104+
text field to have its metadata pulled from the internet and displayed below. Select the latest version and install
105+
it. Make sure to come back to this dialog from time to time to keep each library up to date. Also make sure that you
106106
only have one version of each of the libraries installed.
107107

108108
- [Mini Grafx](https://github.com/ThingPulse/minigrafx) by Daniel Eichhorn
@@ -111,39 +111,39 @@ only have one version of each of the libraries installed.
111111
- [simpleDSTadjust](https://github.com/neptune2/simpleDSTadjust) by neptune2
112112
- [XPT2046 TouchScreen](https://github.com/PaulStoffregen/XPT2046_Touchscreen) by Paul Stoffregen
113113

114-
## Create Wunderground API key
114+
## Create OpenWeatherMap API key
115115

116-
{!../includes/wunderground-key.md!}
116+
{!../includes/openweathermap-key.md!}
117117

118118
## Weather Station Color project
119119

120-
With all the preparation done you will - finally, sigh - turn to the Weather Station Color project itself.
120+
With all the preparation done you will - finally, sigh - turn to the Weather Station Color project itself.
121121
Fortunately, this last step is a rather simple one.
122122

123123
**Obtain the code**
124124

125-
The WiFi Color Kit project is, as all of ThingPulse's open-source code, publicly accessible on GitHub. Hence, there
125+
The WiFi Color Kit project is, as all of ThingPulse's open-source code, publicly accessible on GitHub. Hence, there
126126
are two options to download the code:
127127

128-
- Clone the repository with Git: `git clone https://github.com/ThingPulse/esp8266-weather-station-color`
128+
- Clone the repository with Git: `git clone https://github.com/ThingPulse/esp8266-weather-station-color`
129129
- Download the sources from https://github.com/ThingPulse/esp8266-weather-station-color/archive/master.zip and unpack
130-
them somewhere to your local file system
130+
them somewhere to your local file system
131131

132132
**Open project in Arduino IDE**
133133

134134
- Start the Arduino IDE
135135
- ==File== > ==Open==
136-
- find and select [`esp8266-weather-station-color.ino`](https://github.com/ThingPulse/esp8266-weather-station-color/blob/master/esp8266-weather-station-color.ino)
136+
- find and select [`esp8266-weather-station-color.ino`](https://github.com/ThingPulse/esp8266-weather-station-color/blob/master/esp8266-weather-station-color.ino)
137137
from the previous step.
138138

139139
**Configuration & customization**
140140

141141
In one of the tabs the IDE opened [`settings.h`](https://github.com/ThingPulse/esp8266-weather-station-color/blob/master/settings.h).
142-
Go through the file and adjust the two handful of configuration parameters. They are all documented _inside_ the file
143-
directly. Everything should be self-explanatory. Most importantly you will need to set the Wunderground API key you
142+
Go through the file and adjust the two handful of configuration parameters. They are all documented _inside_ the file
143+
directly. Everything should be self-explanatory. Most importantly you will need to set the Wunderground API key you
144144
obtained in a previous step.
145145

146146
**Upload code to device**
147147

148-
The very last step really is to upload the code and all its dependencies to the device from the Arduino IDE. You do
148+
The very last step really is to upload the code and all its dependencies to the device from the Arduino IDE. You do
149149
this through CTRL + U (⌘ + U on macOS) or ==Sketch== > ==Upload== or the right-arrow icon in the toolbar.

docs/how-tos/openweathermap-key.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Create Wunderground API key
2+
{!../includes/openweathermap-key.md!}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ pages:
4949
- WiFi Color Display Kit: guides/wifi-color-display-kit.md
5050
- How-tos:
5151
- how-tos/wunderground-key.md
52+
- how-tos/openweathermap-key.md
5253
- how-tos/install-drivers.md
5354
- how-tos/Arduino-IDE-for-ESP8266.md
5455
- Hardware specs:

0 commit comments

Comments
 (0)