# MagTag Daily Weather Forecast Display

## Overview

![](https://cdn-learn.adafruit.com/assets/assets/000/132/889/medium800/wireless_banner.jpg?1728319483)

Is the weather outside delightful? Or is it frightful? And what about in the coming days? In this guide we'll show you how to use an [Adafruit MagTag](https://www.adafruit.com/magtag) to create a weather display for today and future conditions.

Using the MagTag's WiFi capability, we connect to a weather API service and get weather information. We then parse that and display it up in a nice summary.

Deep sleep is also used to only run the update once a day around midnight, so we can run for many weeks on one charge.

## Weather API Services

The original code for this guide used the free [weather API service](https://openweathermap.org/api) provided by [OpenWeatherMap](https://openweathermap.org). There have been several updates to the code to keep up with API changes. However, OpenWeather now requires credit card information to obtain an API key - even if only using the free API access. **As a result, this guide no longer uses the OpenWeatherMap API**. The old code is still provided for reference.

The current version of this guide is based on the [weather API](https://open-meteo.com/en/docs) provided by [Open-Meteo](https://open-meteo.com/). This is a truly free weather API which currently does not even require an API key. It is also open source, with the code available in a&nbsp;[GitHub repo](https://github.com/open-meteo/open-meteo). This isn't a 100% drop in replacement in terms of weather forecast information provided. As a result, there are some minor differences relative to the original version.

## Parts

Here are the parts you'll need for this project. You can get them individually:

### Adafruit MagTag - 2.9" Grayscale E-Ink WiFi Display

[Adafruit MagTag - 2.9" Grayscale E-Ink WiFi Display](https://www.adafruit.com/product/4800)
The Adafruit MagTag combines the ESP32-S2 wireless module and a 2.9" grayscale E-Ink display to make a low-power IoT display that can show data on its screen even when power is removed! The ESP32-S2 is great because it builds on the years of code and support for the ESP32 and also adds...

In Stock
[Buy Now](https://www.adafruit.com/product/4800)
[Related Guides to the Product](https://learn.adafruit.com/products/4800/guides)
![Angled shot of rectangle-shaped electronic ink display breakout with the text: "MAGTAG 2025 Edition with SSD1680 Chipset"](https://cdn-shop.adafruit.com/640x480/4800-10.jpg)

### Lithium Ion Polymer Battery with Short Cable - 3.7V 420mAh

[Lithium Ion Polymer Battery with Short Cable - 3.7V 420mAh](https://www.adafruit.com/product/4236)
Lithium-ion polymer (also known as 'lipo' or 'lipoly') batteries are thin, light, and powerful. The output ranges from 4.2V when completely charged to 3.7V. This battery has a capacity of 420mAh for a total of about 1.55 Wh. If you need a larger (or smaller!) battery, <a...></a...>

In Stock
[Buy Now](https://www.adafruit.com/product/4236)
[Related Guides to the Product](https://learn.adafruit.com/products/4236/guides)
![Lithium Ion Polymer Battery 3.7v 420mAh with JST 2-PH connector and short cable](https://cdn-shop.adafruit.com/640x480/4236-04.jpg)

### Mini Magnet Feet for RGB LED Matrices (Pack of 4)

[Mini Magnet Feet for RGB LED Matrices (Pack of 4)](https://www.adafruit.com/product/4631)
Got a glorious&nbsp;RGB Matrix project you want to mount and display in your workspace or home? If you have one of the matrix panels listed below, you'll need a pack of these **Mini-Magnet Feet.** &nbsp;We got these specifically&nbsp;for our RGB LED Matrices, which no longer...

In Stock
[Buy Now](https://www.adafruit.com/product/4631)
[Related Guides to the Product](https://learn.adafruit.com/products/4631/guides)
![Angled shot of four magnet feet.](https://cdn-shop.adafruit.com/640x480/4631-00.jpg)

 **OR** these items are also available together as a kit:

### Adafruit MagTag Starter Kit - ADABOX017 Essentials

[Adafruit MagTag Starter Kit - ADABOX017 Essentials](https://www.adafruit.com/product/4819)
The **Adafruit MagTag** combines the new ESP32-S2 wireless module and a 2.9" grayscale E-Ink display to make a low-power IoT display that can show data on its screen even when power is removed! The ESP32-S2 is great because it builds on the years of code and support for the...

In Stock
[Buy Now](https://www.adafruit.com/product/4819)
[Related Guides to the Product](https://learn.adafruit.com/products/4819/guides)
![MagTag dev board with enclosure pieces, four magnet feet, and lipoly battery](https://cdn-shop.adafruit.com/640x480/4819-02.jpg)

# MagTag Daily Weather Forecast Display

## Install CircuitPython

Danger: Make sure that you [update the TinyUF2 Bootloader](https://learn.adafruit.com/adafruit-magtag/update-tinyuf2-bootloader-for-circuitpython-10-4mb-boards-only) before installing CircuitPython!

### Adafruit MagTag - Update TinyUF2 Bootloader for CircuitPython 10 and Later

[Adafruit MagTag](https://learn.adafruit.com/adafruit-magtag)
[Update TinyUF2 Bootloader for CircuitPython 10 and Later](https://learn.adafruit.com/adafruit-magtag/update-tinyuf2-bootloader-for-circuitpython-10-4mb-boards-only)
[CircuitPython](https://github.com/adafruit/circuitpython) is a derivative of [MicroPython](https://micropython.org) designed to simplify experimentation and education on low-cost microcontrollers. It makes it easier than ever to get prototyping by requiring no upfront desktop software downloads. Simply copy and edit files on the **CIRCUITPY** drive to iterate.

## Set Up CircuitPython

Follow the steps to get CircuitPython installed on your MagTag.

[CircuitPython Download for MagTag](https://circuitpython.org/board/adafruit_magtag_2.9_grayscale/)
Warning: WARNING: The updated Adafruit MagTag 2025 Edition will not work with CircuitPython 9.2.x or earlier. Make sure you install 10.x.x or later!

 **Click the link above and download the latest .BIN and .UF2 file**

You can use a 9.x.x release for a pre-2025 MagTag. You&nbsp; **must** use a 10.x.x release for the updated MagTag 2025 Edition.

(depending on how you program the ESP32S2 board you may need one or the other, might as well get both)

Download and save it to your desktop (or wherever is handy).

![](https://cdn-learn.adafruit.com/assets/assets/000/138/625/medium640/adafruit_products_magtag-9.2.8.png?1753973423)

![](https://cdn-learn.adafruit.com/assets/assets/000/138/626/medium640/adafruit_products_magtag-10.0.0-beta.2.png?1753973581)

Plug your MagTag into your computer using a known-good USB cable.

**A lot of people end up using charge-only USB cables and it is very frustrating! So make sure you have a USB cable you know is good for data sync.**

![adafruit_products_MagTag_top.jpg](https://cdn-learn.adafruit.com/assets/assets/000/096/955/medium640/adafruit_products_MagTag_top.jpg?1605035864)

# Option 1 - Load with UF2 Bootloader

This is by far the easiest way to load CircuitPython. **However it requires your board has the UF2 bootloader installed. Some early boards do not (we hadn't written UF2 yet!) - in which case you can load using the built in ROM bootloader.**

Still, try this first!

Warning: Make sure that you [update the TinyUF2 Bootloader](https://learn.adafruit.com/adafruit-magtag/update-tinyuf2-bootloader-for-circuitpython-10-4mb-boards-only) before following these steps for the UF2 bootloader!

## Try Launching UF2 Bootloader

Loading CircuitPython by drag-n-drop UF2 bootloader is the easier way and we recommend it. If you have a MagTag where the front of the board is black, your MagTag came with UF2 already on it.

![adafruit_products_IMG_0169.jpg](https://cdn-learn.adafruit.com/assets/assets/000/097/429/medium640/adafruit_products_IMG_0169.jpg?1607200225)

Launch UF2 by **double-clicking** the Reset button (the one next to the USB C port). You may have to try a few times to get the timing right.

![adafruit_products_MagTag_pinouts_Reset_and_Boot0.jpg](https://cdn-learn.adafruit.com/assets/assets/000/097/430/medium640/adafruit_products_MagTag_pinouts_Reset_and_Boot0.jpg?1607202717)

If the UF2 bootloader is installed, you will see a new disk drive appear called **MAGTAGBOOT**

![adafruit_products_image.png](https://cdn-learn.adafruit.com/assets/assets/000/097/431/medium640/adafruit_products_image.png?1607202820)

Copy the **UF2** file you downloaded at the first step of this tutorial onto the **MAGTAGBOOT** drive

![adafruit_products_image.png](https://cdn-learn.adafruit.com/assets/assets/000/097/432/medium640/adafruit_products_image.png?1607202977)

If you're using Windows and you get an error at the end of the file copy that says **Error from the file copy, Error 0x800701B1: A device which does not exist was specified.** You can ignore this error, the bootloader sometimes disconnects without telling Windows, the install completed just fine and you can continue.[If its really annoying, you can also upgrade the bootloader (the latest version of the UF2 bootloader fixes this warning)](https://learn.adafruit.com/adafruit-magtag/install-uf2-bootloader)

Your board should auto-reset into CircuitPython, or you may need to press reset. A **CIRCUITPY** drive will appear. You're done! Go to the next pages.

![adafruit_products_image.png](https://cdn-learn.adafruit.com/assets/assets/000/097/433/medium640/adafruit_products_image.png?1607203475)

# Option 2 - Use esptool to load BIN file

If you have an original MagTag with while soldermask on the front, we didn't have UF2 written for the ESP32S2 yet so it will not come with the UF2 bootloader.

You can upload with **esptool** to the ROM (hardware) bootloader instead!

Follow the initial steps found in the [Run esptool and check connection section of the ROM Bootloader page](https://learn.adafruit.com/adafruit-magtag/rom-bootloader#run-esptool-and-check-connection-3076823-5) to verify your environment is set up, your board is successfully connected, and which port it's using.

**In the final command to write a binary file to the board, replace the port with your port, and replace "firmware.bin" with the the file you downloaded above.**

The output should look something like the output in the image.

![adafruit_products_Metro_ESP32_S2_binary_install.png](https://cdn-learn.adafruit.com/assets/assets/000/096/950/medium640/adafruit_products_Metro_ESP32_S2_binary_install.png?1605031120)

Press reset to exit the bootloader.

Your **CIRCUITPY** drive should appear!

You're all set! Go to the next pages.

![adafruit_products_Metro_ESP32_S2_CIRCUITPY.png](https://cdn-learn.adafruit.com/assets/assets/000/096/951/medium640/adafruit_products_Metro_ESP32_S2_CIRCUITPY.png?1605031168)

# Option 3 - Use Chrome Browser To Upload BIN file

If for some reason you cannot get esptool to run, you can always try using the Chrome-browser version of esptool we have written. This is handy if you don't have Python on your computer, or something is really weird with your setup that makes esptool not run (which happens sometimes and isn't worth debugging!) You can follow along on the [Web Serial ESPTool](https://learn.adafruit.com/adafruit-magtag/web-serial-esptool) page and either load the UF2 bootloader and then come back to Option 1 on this page, or you can download the CircuitPython BIN file directly using the tool in the same manner as the bootloader.

# MagTag Daily Weather Forecast Display

## CircuitPython Internet Test

One of the great things about most Espressif microcontrollers are their built-in WiFi capabilities. This page covers the basics of getting connected using CircuitPython.

The first thing you need to do is update your **code.py** to the following (it will error until WiFi details are added). Click the **Download Project Bundle** button to download the necessary libraries and the&nbsp; **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire**  **lib**  **folder** and the **code.py** file to your **CIRCUITPY** drive.

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/ESP32_S2_WiFi_Tests/CPy_Native_WiFi_Test/code.py

Your **CIRCUITPY** drive should resemble the following.

![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/ESP32_S2_WiFi_Tests_CPy_Native_WiFi_Test.png )

To get connected, the next thing you need to do is update the **settings.toml** file.

## The settings.toml File

We expect people to share tons of projects as they build CircuitPython WiFi widgets. What we want to avoid is people accidentally sharing their passwords or secret tokens and API keys. So, we designed all our examples to use a **settings.toml** file, that is on your&nbsp; **CIRCUITPY** &nbsp;drive, to hold secret/private/custom data. That way you can share your main project without worrying about accidentally sharing private stuff.

If you have a fresh install of CircuitPython on your board, the initial **settings.toml** file on your **CIRCUITPY** drive is empty.

To get started, you can update the **settings.toml** on your **CIRCUITPY** drive to contain the following code.

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/ESP32_S2_WiFi_Tests/CPy_Native_WiFi_Test/settings.toml

This file should contain a series of Python variables, each assigned to a string. Each variable should describe what it represents (say&nbsp;`wifi_ssid`), followed by an **=&nbsp;** (equals sign), followed by the data in the form of a Python string (such as `"my-wifi-password"` including the quote marks).

**At a minimum you'll need to add/update your WiFi SSID and WiFi password, so do that now!**

As you make projects you may need more tokens and keys, just add them one line at a time. See for example other tokens such as one for accessing GitHub or the Hackaday API. Other non-secret data like your timezone can also go here.

For the correct time zone string, look at&nbsp;[http://worldtimeapi.org/timezones](http://worldtimeapi.org/timezones)&nbsp;and remember that if your city is not listed, look for a city in the same time zone, for example Boston, New York, Philadelphia, Washington DC, and Miami are all on the same time as New York.

Of course, don't share your **settings.toml** - keep that out of GitHub, Discord or other project-sharing sites.

Warning: 

If you connect to the serial console, you should see something like the following:

![](https://cdn-learn.adafruit.com/assets/assets/000/097/014/medium800/adafruit_products_1__screen__Users_brentrubell__screen_.png?1605218222)

In order, the example code...

Checks the ESP32's MAC address.

```python
print(f"My MAC address: {[hex(i) for i in wifi.radio.mac_address]}")
```

Performs a scan of all access points and prints out the access point's name (SSID), signal strength (RSSI), and channel.

```python
print("Available WiFi networks:")
for network in wifi.radio.start_scanning_networks():
    print("\t%s\t\tRSSI: %d\tChannel: %d" % (str(network.ssid, "utf-8"),
                                             network.rssi, network.channel))
wifi.radio.stop_scanning_networks()
```

Connects to the access point you defined in the **settings.toml** file, and prints out its local IP address.

```python
print(f"Connecting to {os.getenv('WIFI_SSID')}")
wifi.radio.connect(os.getenv("WIFI_SSID"), os.getenv("WIFI_PASSWORD"))
print(f"Connected to {os.getenv('WIFI_SSID')}")
print(f"My IP address: {wifi.radio.ipv4_address}")
```

Attempts to ping a Google DNS server to test connectivity. If a ping fails, it returns `None`. Initial pings can sometimes fail for various reasons. So, if the initial ping is successful (`is not None`), it will print the echo speed in ms. If the initial ping fails, it will try one more time to ping, and then print the returned value. If the second ping fails, it will result in `"Ping google.com: None ms"` being printed to the serial console. Failure to ping does not always indicate a lack of connectivity, so the code will continue to run.

```python
ping_ip = ipaddress.IPv4Address("8.8.8.8")
ping = wifi.radio.ping(ip=ping_ip) * 1000
if ping is not None:
    print(f"Ping google.com: {ping} ms")
else:
    ping = wifi.radio.ping(ip=ping_ip)
    print(f"Ping google.com: {ping} ms")
```

The code creates a socketpool using the wifi radio's available sockets. This is performed so we don't need to re-use sockets. Then, it initializes a a new instance of the [requests](http://docs.python-requests.org/en/master/) interface - which makes getting data from the internet _really really easy._

```python
pool = socketpool.SocketPool(wifi.radio)
requests = adafruit_requests.Session(pool, ssl.create_default_context())
```

To read in plain-text from a web URL, call `requests.get` - you may pass in either a http, or a http **s** url for SSL connectivity.&nbsp;

```python
print(f"Fetching text from {TEXT_URL}")
response = requests.get(TEXT_URL)
print("-" * 40)
print(response.text)
print("-" * 40)
```

Requests can also display a JSON-formatted response from a web URL using a call to `requests.get`.&nbsp;

```python
print(f"Fetching json from {JSON_QUOTES_URL}")
response = requests.get(JSON_QUOTES_URL)
print("-" * 40)
print(response.json())
print("-" * 40)
```

Finally, you can fetch and parse a JSON URL using `requests.get`. This code snippet obtains the `stargazers_count` field from a call to the GitHub API.

```python
print(f"Fetching and parsing json from {JSON_STARS_URL}")
response = requests.get(JSON_STARS_URL)
print("-" * 40)
print(f"CircuitPython GitHub Stars: {response.json()['stargazers_count']}")
print("-" * 40)
```

OK you now have your ESP32 board set up with a proper **settings.toml** file and can connect over the Internet. If not, check that your **settings.toml** file has the right SSID and password and retrace your steps until you get the Internet connectivity working!

## IPv6 Networking

Starting in CircuitPython 9.2, IPv6 networking is available on most Espressif wifi boards. Socket-using libraries like **adafruit\_requests** and **adafruit\_ntp** will need to be updated to use the new APIs and for now can only connect to services on IPv4.

### IPv6 connectivity & privacy

IPv6 addresses are divided into many special kinds, and many of those kinds (like those starting with&nbsp; **FC** , **FD** , **FE** ) are private or local; Addresses starting with other prefixes like&nbsp; **2002:** and **2001:** are globally routable. In 2024, far from all ISPs and home networks support IPv6 internet connectivity. For more info consult resources like [Wikipedia](https://en.wikipedia.org/wiki/IPv6_address#Local_addresses). If you're interested in global IPv6 connectivity you can use services like [Hurricane Electric](https://www.he.net/) to create an "IPv6 tunnel" (free as of 2024, but requires expertise and a compatible router or host computer to set up)

It's also important to be aware that, as currently implemented by Espressif, there are privacy concerns especially when these devices operate on the global IPv6 network: The device's unique identifier (its EUI-64 or MAC address) is used by default as part of its IPv6 address. This means that the device identity can be tracked across multiple networks by any service it connects to.

### Enable IPv6 networking

Due to the privacy consideration, IPv6 networking is not automatically enabled. Instead, it must be explicitly enabled by a call to `start_dhcp_client` with the `ipv6=True` argument specified:

```python
wifi.start_dhcp_client(ipv6=True)
```

### Check IP addresses

The read-only&nbsp;`addresses` property of the `wifi.radio` object holds all addresses, including IPv4 and IPv6 addresses:

```python
&gt;&gt;&gt; wifi.radio.addresses
('FE80::7EDF:A1FF:FE00:518C', 'FD5F:3F5C:FE50:0:7EDF:A1FF:FE00:518C', '10.0.3.96')
```

The `wifi.radio.dns` servers can be IPv4 or IPv6:

```python
&gt;&gt;&gt; wifi.radio.dns
('FD5F:3F5C:FE50::1',)
&gt;&gt;&gt; wifi.radio.dns = ("1.1.1.1",)
&gt;&gt;&gt; wifi.radio.dns
('1.1.1.1',)
```

### Ping v6 networks

`wifi.radio.ping` accepts v6 addresses and names:

```python
&gt;&gt;&gt; wifi.radio.ping("google.com")
0.043
&gt;&gt;&gt; wifi.radio.ping("ipv6.google.com")
0.048
```

### Create & use IPv6 sockets

Use the address family `socket.AF_INET6`. After the socket is created, use methods like `connect`, `send`, `recfrom_into`, etc just like for IPv4 sockets. This code snippet shows communicating with a private-network NTP server; this IPv6 address will not work on your network:

```python
&gt;&gt;&gt; ntp_addr = ("fd5f:3f5c:fe50::20e", 123)
&gt;&gt;&gt; PACKET_SIZE = 48
&gt;&gt;&gt; 
&gt;&gt;&gt; buf = bytearray(PACKET_SIZE)
&gt;&gt;&gt; with socket.socket(socket.AF_INET6, socket.SOCK_DGRAM) as s:
...     s.settimeout(1)
...     buf[0] = 0b0010_0011
...     s.sendto(buf, ntp_addr)
...     print(s.recvfrom_into(buf))
...     print(buf)
... 
48
(48, ('fd5f:3f5c:fe50::20e', 123))
bytearray(b'$\x01\x03\xeb\x00\x00\x00\x00\x00\x00\x00GGPS\x00\xeaA0h\x07s;\xc0\x00\x00\x00\x00\x00\x00\x00\x00\xeaA0n\xeb4\x82-\xeaA0n\xebAU\xb1')
```

# MagTag Daily Weather Forecast Display

## Project Code Install

Here is the project code and other assets. Once installed, see the next guide section for how to configure the code for your location and other settings.

## Weather Icons

The icons used in this project were inspired by this other EPD based weather project - [eInk / ePaper Weather Station](https://learn.adafruit.com/epaper-weather-station). They are the excellent set of [Meteocons](https://www.alessioatzeni.com/meteocons/) , which the [author](https://www.alessioatzeni.com/meteocons/#about) has made freely available. For this project, we converted them to gray scale, scaled them as needed, and converted to bitmap.

## Installing Project Code

To use with CircuitPython, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the code listing below.

Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **MagTag\_Weather/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/MagTag/MagTag_Weather/openmeteo/code.py

# MagTag Daily Weather Forecast Display

## Configuration

Once the project code and assets have been installed to the Magtag, edit the **code.py** file to make configuration changes as described below.

All changes are made by editing this small code block found at the top of the code listing:

```python
# --| USER CONFIG |--------------------------
LAT = 47.6                  # latitude
LON = -122.3                # longitude
TMZ = "America/Los_Angeles" # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
METRIC = False              # set to True for metric units
# -------------------------------------------
```

## Set Location

The Open-Meteo API currently only works with location specified by latitude and longitude. There's a simple geocoding API accessible here:

[Geocoding API](https://open-meteo.com/en/docs/geocoding-api)
that can be used to find the latitude and longitude for your location. Search for your location and then find the appropriate latitude and longitude in the results table.

![](https://cdn-learn.adafruit.com/assets/assets/000/132/890/medium800/wireless_location.jpg?1728320575)

Update these lines of code with the latitude (LAT) and longitude (LON) values:

```python
LAT = 47.6                  # latitude
LON = -122.3                # longitude
```

## Set Timezone

The timezone for the location also needs to be specified. Use the link below to find the appropriate name to use:&nbsp;

[List of Time Zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
Use the text from the **TZ indentifier** column in the timezone list table and update this line of code:

```python
TMZ = "America/Los_Angeles" # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
```

Warning: NOTE: The TMZ value must be set as a string, so don't forget the surrounding quotation marks.

## Set Units

The units used for temperature and wind speed can be set to either imperial (deg F, mph) or metric (deg C, kmh). By default, imperial is used. To switch to metric, set the **METRIC** option to **True** :

```python
METRIC = True              # set to True for metric units
```

# MagTag Daily Weather Forecast Display

## OpenWeatherMap Project Code (OLD)

Danger: This code is no longer supported and only here for reference.

![](https://cdn-learn.adafruit.com/assets/assets/000/132/888/medium800/wireless_banner.jpg?1728319458)

Here is the project code along with some additional setup needed.

As a result of changes in OpenWeather's API and pricing, there are two versions of the code. The two versions of the code are provided below in separate guide sections.

- **One Call API** - This is "free" (up to 1000 API calls/day), but requires providing credit card information when setting up.
- **Forecast API** - This is free without providing credit card info.

The code was originally written using the One Call API, before the credit card requirement was added. The second version was written after that requirement was added using the different, but still free, Forecast API. It works mostly the same as the original One Call API version.

## Weather Icons

The icons used in this project were inspired by this other EPD based weather project - [eInk / ePaper Weather Station](https://learn.adafruit.com/epaper-weather-station). They are the excellent set of [Meteocons](https://www.alessioatzeni.com/meteocons/) , which the [author](https://www.alessioatzeni.com/meteocons/#about) has made freely available. For this project, we converted them to gray scale, scaled them as needed, and converted to bitmap.

## Open Weather Maps API Key

We'll be using [OpenWeatherMap.org](https://openweathermap.org/) to retrieve the weather info through its [API](https://openweathermap.org/api). In order to do so, you'll need to register for an account and get your API key.

Go to this [link](https://home.openweathermap.org/users/sign_up) and register for a free account. Once registered, you'll get an email containing your API key, also known as the "openweather token".

Copy and paste this key into your **settings.toml** file that is on the root level of your **CIRCUITPY** drive. Name the entry `openweather_token`, ex:

```python
openweather_token="my_openweather_token"
```

It'll look something like this

`openweather_token="b218dde228d7be12f16bf4640208b9f5"`

this is not a valid token, you have to get your own!

Warning: 

## Set Location

We will also use **settings.toml** to set your location. To do so, add new entry called `openweather_location` and specify **either** your city name and country code:

```python
openweather_location="Thief River Falls, US"
```

 **or** by using a two tuple of latitude and longitude:

```python
openweather_location="47.6062,-122.3321"
```

Note that negative longitude values are use for West.

You can verify your town or city is valid by visiting [https://openweathermap.org/find](https://openweathermap.org/find) and typing it into the box, if you get a weather report, then that's a known city! However, if you run into a situation where the city name is ambiguous (multiple same name cities), then use the latitude/longitude value to specify location.

## Celsius or Fahrenheit

The units used for the temperature readings can be set to either Celsius or Fahrenheit. The units are set to Fahrenheit by default. To change to Celsius, look for this line of code:

```auto
METRIC = False  # set to True for metric units
```

and change it to:

```auto
METRIC = True  # set to True for metric units
```

In addition to changing temperature readings to Celsius, this will also change the wind readings to meters per second.

## Settings Summary

Your resulting **settings.toml** file should looking something like the example below, but with your specific values. It's OK if there are more entries - for other services, etc. But you need at least the ones shown here.

```python
CIRCUITPY_WIFI_SSID="your-wifi-ssid"
CIRCUITPY_WIFI_PASSWORD="your-wifi-password"
openweather_token="my_openweather_token"
openweather_location="Thief River Falls, US"
```

## Installing Project Code

To use with CircuitPython, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the code listing below.

Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **MagTag\_Weather/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.

**Note that there are two versions of the code located in subfolders** :

- **onecall** - Requires non-free account/API key.
- **forecast** - Works with free account/API key.

See the code specific sections below for more detail. Only one version should be used at a time.

Warning: 

### One Call API (non free)

This is the original version of the code, written when access to the One Call API was available with a free API key. The One Call API now requires the API key be associated with an [Openweathermap](https://home.openweathermap.org) account that's been set up for payments.

Older account/API keys _ **may** _ still work. For any new accounts/API keys that want a free version, the Forecast API version of the code below will likely be needed.

![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/MagTag_MagTag_Weather_onecall.png )

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/MagTag/MagTag_Weather/onecall/code.py

### Forecast API (free)

This is a newer version of the code that uses the still free 5 Day / 3 Hour Forecast API. It attempts to provide the same informational display as the original version of the code. However, since there are some differences in the nature of the data returned by the two API's, there are some caveats.

- The forecast is for only four days, not five. That's because one of the "5 days" is the current day.
- Weather conditions forecasted for noon local time are used as "daily forecast". There is no "daily" summary forecast available as there is with the One Call API.

![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/MagTag_MagTag_Weather_forecast.png )

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/MagTag/MagTag_Weather/forecast/code.py


## Featured Products

### Adafruit MagTag - 2.9" Grayscale E-Ink WiFi Display

[Adafruit MagTag - 2.9" Grayscale E-Ink WiFi Display](https://www.adafruit.com/product/4800)
The Adafruit MagTag combines the ESP32-S2 wireless module and a 2.9" grayscale E-Ink display to make a low-power IoT display that can show data on its screen even when power is removed! The ESP32-S2 is great because it builds on the years of code and support for the ESP32 and also adds...

In Stock
[Buy Now](https://www.adafruit.com/product/4800)
[Related Guides to the Product](https://learn.adafruit.com/products/4800/guides)
### Adafruit MagTag Starter Kit - ADABOX017 Essentials

[Adafruit MagTag Starter Kit - ADABOX017 Essentials](https://www.adafruit.com/product/4819)
The **Adafruit MagTag** combines the new ESP32-S2 wireless module and a 2.9" grayscale E-Ink display to make a low-power IoT display that can show data on its screen even when power is removed! The ESP32-S2 is great because it builds on the years of code and support for the...

In Stock
[Buy Now](https://www.adafruit.com/product/4819)
[Related Guides to the Product](https://learn.adafruit.com/products/4819/guides)

## Related Guides

- [Adafruit MagTag](https://learn.adafruit.com/adafruit-magtag.md)
- [CircuitPython Animated Holiday Wreath Lights](https://learn.adafruit.com/circuitpython-animated-holiday-wreath-lights.md)
- [MagTag Lists From Google Spreadsheets](https://learn.adafruit.com/collaborative-spreadsheets-to-magtag.md)
- [Deep Sleep with CircuitPython](https://learn.adafruit.com/deep-sleep-with-circuitpython.md)
- [Google Graveyard with Adafruit MagTag](https://learn.adafruit.com/google-graveyard-with-adafruit-magtag.md)
- [MagTag Google Calendar Event Display](https://learn.adafruit.com/magtag-google-calendar-event-display.md)
- [MagTag James Webb Telescope Status](https://learn.adafruit.com/magtag-james-webb-telescope-status.md)
- [Creating MagTag Projects with CircuitPython](https://learn.adafruit.com/creating-magtag-projects-with-circuitpython.md)
- [Language Flashcards on the MagTag](https://learn.adafruit.com/magtag-flashcards.md)
- [Haiku Viewer for MagTag](https://learn.adafruit.com/haiku-viewer-for-magtag.md)
- [Adafruit MagTag COVID Vaccination Percent Tracker](https://learn.adafruit.com/adafruit-magtag-covid-vaccination-percent-tracker.md)
- [MagTag Tides Viewer](https://learn.adafruit.com/magtag-tides-viewer.md)
- [MagTag AR Tarot Card Reading](https://learn.adafruit.com/magtag-tarot-cards.md)
- [MagTag Weekly Showtimes Event Notifier](https://learn.adafruit.com/magtag-weekly-event-showtimes-display.md)
- [Adafruit ADG729 Dual 1-to-4 Analog Matrix Switch](https://learn.adafruit.com/adafruit-adg729-dual-1-to-4-analog-matrix-switch.md)
- [CircuitPython on the Xteink X4 eReader](https://learn.adafruit.com/circuitpython-on-the-xteink-x4-ereader.md)
