# PyPortal Air Quality Display ## Overview ![](https://cdn-learn.adafruit.com/assets/assets/000/072/501/medium800/wireless_airIMG_4431_2k.jpg?1552183444) With the PyPortal air quality display stuck to your fridge, you can keep track of the quality of the air you breathe. Using CircuitPython, this project queries the AirNow site API to find out the current air quality index for your location and displays it along with an informative color. [3D printed case](https://learn.adafruit.com/pyportal-case) and magnetic backing allow you to mount it to your fridge or other ferrous metal surface. Info: ### Adafruit PyPortal - CircuitPython Powered Internet Display [Adafruit PyPortal - CircuitPython Powered Internet Display](https://www.adafruit.com/product/4116) **PyPortal** , our easy-to-use IoT device that allows you to create all the things for the “Internet of Things” in minutes. Make custom touch screen interface GUIs, all open-source, and Python-powered using tinyJSON / APIs to get news, stock, weather, cat photos,... Out of Stock [Buy Now](https://www.adafruit.com/product/4116) [Related Guides to the Product](https://learn.adafruit.com/products/4116/guides) ![Front view of a Adafruit PyPortal - CircuitPython Powered Internet Display with a pyportal logo image on the display. ](https://cdn-shop.adafruit.com/640x480/4116-00.jpeg) ### 5V 2A Switching Power Supply w/ USB-A Connector [5V 2A Switching Power Supply w/ USB-A Connector](https://www.adafruit.com/product/1994) Our 5V 2A USB power adapter is the perfect choice for powering single-board computers like Raspberry Pi, BeagleBone, or anything else that's power-hungry! This adapter was specifically designed to provide 5.25V, not 5V, but we still call it a 5V USB adapter. We did this on purpose to... In Stock [Buy Now](https://www.adafruit.com/product/1994) [Related Guides to the Product](https://learn.adafruit.com/products/1994/guides) ![5V 2A Switching Power Supply with USB-A Connector](https://cdn-shop.adafruit.com/640x480/1994-01.jpg) ### USB A/Micro Cable - 2m [USB A/Micro Cable - 2m](https://www.adafruit.com/product/2185) This is your standard USB A-Plug to Micro-USB cable. It's 2 meters long so you'll have plenty of cord to work with for those longer extensions. Out of Stock [Buy Now](https://www.adafruit.com/product/2185) [Related Guides to the Product](https://learn.adafruit.com/products/2185/guides) ![USB Cable with Type A and Micro B ends](https://cdn-shop.adafruit.com/640x480/2185-00.jpg) ## Additional Tools & Materials You may want to create the optional mounting case for your PyPortal Air Quality Display. For this you'll need: - [3D printer](https://www.adafruit.com/product/2673) - [Filament](https://www.adafruit.com/product/3731) - [PyPortal Case model files](https://learn.adafruit.com/pages/15333/elements/3021596/download?type=zip) - [M2.5 screws](https://www.adafruit.com/product/3299) If you don't have access to a 3D printer you can optionally use an online service such as 3D Hubs to have it printed for you on demand. ### Magnetic Pin Back [Magnetic Pin Back](https://www.adafruit.com/product/1170) These magnetic pin backs have two pieces: a metal bar with adhesive strip and a plastic piece with two strong rare-earth magnets. Affix the metal bar to your FLORA projects-- it's just the right size! Then attach your FLORA project to any garment without poking holes in your clothes. The... In Stock [Buy Now](https://www.adafruit.com/product/1170) [Related Guides to the Product](https://learn.adafruit.com/products/1170/guides) ![a metal bar with adhesive strip and a plastic piece.](https://cdn-shop.adafruit.com/640x480/1170-04.jpg) ### Black Nylon Machine Screw and Stand-off Set – M2.5 Thread [Black Nylon Machine Screw and Stand-off Set – M2.5 Thread](https://www.adafruit.com/product/3299) Totaling 380 pieces, this **M2.5 Screw Set**  is a must-have for your workstation. You'll have enough screws, nuts, and hex standoffs to fuel your maker tendencies for days on end! M2.5 size screws fit almost all of the Adafruit breakout/dev board mounting holes... In Stock [Buy Now](https://www.adafruit.com/product/3299) [Related Guides to the Product](https://learn.adafruit.com/products/3299/guides) ![Black Nylon Screw and Stand-off Set with M2.5 Threads, kit box](https://cdn-shop.adafruit.com/640x480/3299-00.jpg) # PyPortal Air Quality Display ## Install CircuitPython [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**  "flash" drive to iterate. The following instructions will show you how to install CircuitPython. If you've already installed CircuitPython but are looking to update it or reinstall it, the same steps work for that as well! ## Set up CircuitPython Quick Start! Follow this quick step-by-step for super-fast Python power :) [Download the latest version of CircuitPython for the PyPortal via CircuitPython.org](https://circuitpython.org/board/pyportal/) [Download the latest version of CircuitPython for the PyPortal Pynt via CircuitPython.org](https://circuitpython.org/board/pyportal_pynt/) **Click the link above to download the latest version of CircuitPython for the PyPortal.** Download and save it to your desktop (or wherever is handy). ![circuitpython_pyportal-uf2.png](https://cdn-learn.adafruit.com/assets/assets/000/073/615/medium640/circuitpython_pyportal-uf2.png?1553610968) Plug your PyPortal 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.** Double-click the **Reset** button on the top in the middle (magenta arrow) on your board, and you will see the NeoPixel RGB LED (green arrow) turn green. If it turns red, check the USB cable, try another USB port, etc.  **Note:** The little red LED next to the USB connector will pulse red. That's ok! If double-clicking doesn't work the first time, try again. Sometimes it can take a few tries to get the rhythm right! ![circuitpython_PyPortalResetNeoPIxel.jpg](https://cdn-learn.adafruit.com/assets/assets/000/071/993/medium640/circuitpython_PyPortalResetNeoPIxel.jpg?1551213425) You will see a new disk drive appear called **PORTALBOOT**. Drag the **adafruit-circuitpython-pyportal-\.uf2** file to **PORTALBOOT.** ![circuitpython_PyPortal_PORTALBOOT.png](https://cdn-learn.adafruit.com/assets/assets/000/072/029/medium640/circuitpython_PyPortal_PORTALBOOT.png?1551287972) ![circuitpython_PyPortal_Drag_UF2.png](https://cdn-learn.adafruit.com/assets/assets/000/072/030/medium640/circuitpython_PyPortal_Drag_UF2.png?1551287983) The LED will flash. Then, the **PORTALBOOT** drive will disappear and a new disk drive called **CIRCUITPY** will appear. If you haven't added any code to your board, the only file that will be present is **boot\_out.txt**. This is absolutely normal! It's time for you to add your **code.py** and get started! That's it, you're done! :) ![circuitpython_PyPortalCIRCUITPY.png](https://cdn-learn.adafruit.com/assets/assets/000/071/995/medium640/circuitpython_PyPortalCIRCUITPY.png?1551213875) ## PyPortal Default Files Click below to download a zip of the files that shipped on the PyPortal or PyPortal Pynt. [PyPortal Default Files](https://github.com/adafruit/circuitpython-default-files/tree/main/boards/pyportal/4.x) [PyPortal Pynt Default Files](https://github.com/adafruit/circuitpython-default-files/tree/main/boards/pyportal_pynt/5.x) # PyPortal Air Quality Display ## PyPortal CircuitPython Setup To use all the amazing features of your PyPortal with CircuitPython, you must first install a number of libraries. This page covers that process. # Adafruit CircuitPython Bundle Download the Adafruit CircuitPython Library Bundle. You can find the latest release here: [Latest Adafruit CircuitPython Library Bundle](https://circuitpython.org/libraries) Download the **adafruit-circuitpython-bundle-\*.x-mpy-\*.zip** bundle zip file where **\*.x MATCHES THE VERSION OF CIRCUITPYTHON YOU INSTALLED** , and unzip a folder of the same name. Inside you'll find a **lib** folder. You have two options: - You can add the **lib** folder to your **CIRCUITPY** drive. This will ensure you have _all the drivers_. But it will take a bunch of space on the 8 MB disk - Add each library as you need it, this will reduce the space usage but you'll need to put in a little more effort. At a minimum we recommend the following libraries, in fact we more than recommend. They're basically required. So grab them and install them into **CIRCUITPY/lib** now! - **adafruit\_esp32spi** - This is the library that gives you internet access via the ESP32 using (you guessed it!) SPI transport. You need this for anything Internet - **adafruit\_requests** - This library allows us to perform HTTP requests and get responses back from servers. GET/POST/PUT/PATCH - they're all in here! - adafruit\_connection\_manager - used by adafruit\_requests. - **adafruit\_pyportal** - This is our friendly wrapper library that does a lot of our projects, displays graphics and text, fetches data from the internet. Nearly all of our projects depend on it! - **adafruit\_portalbase**  - This library is the base library that adafruit\_pyportal library is built on top of. - **adafruit\_touchscreen** - a library for reading touches from the resistive touchscreen. Handles all the analog noodling, rotation and calibration for you. - **adafruit\_io** - this library helps connect the PyPortal to our free datalogging and viewing service - **adafruit\_imageload** - an image display helper, required for any graphics! - **adafruit\_display\_text** - not surprisingly, it displays text on the screen - **adafruit\_bitmap\_font** - we have fancy font support, and its easy to make new fonts. This library reads and parses font files. - **adafruit\_slideshow** - for making image slideshows - handy for quick display of graphics and sound - **neopixel** - for controlling the onboard neopixel - **adafruit\_adt7410** - library to read the temperature from the on-board Analog Devices ADT7410 precision temperature sensor (not necessary for Titano or Pynt) - **adafruit\_bus\_device** - low level support for I2C/SPI - **adafruit\_fakerequests**  - This library allows you to create fake HTTP requests by using local files. # PyPortal Air Quality Display ## Create Your settings.toml File CircuitPython works with WiFi-capable boards to enable you to make projects that have network connectivity. This means working with various passwords and API keys. As of [CircuitPython 8](https://circuitpython.org/downloads), there is support for a **settings.toml** file. This is a file that is stored on your **CIRCUITPY** drive, that contains all of your secret network information, such as your SSID, SSID password and any API keys for IoT services. It is designed to separate your sensitive information from your **code.py** file so you are able to share your code without sharing your credentials. CircuitPython previously used a **secrets.py** file for this purpose. The **settings.toml** file is quite similar. Warning: Your **settings.toml** file should be stored in the main directory of your **CIRCUITPY** drive. It should not be in a folder. ## CircuitPython **settings.toml** File This section will provide a couple of examples of what your **settings.toml** file should look like, specifically for CircuitPython WiFi projects in general. The most minimal **settings.toml** file must contain your WiFi SSID and password, as that is the minimum required to connect to WiFi. Copy this example, paste it into your **settings.toml** , and update: - `your_wifi_ssid` - `your_wifi_password` ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" ``` Many CircuitPython network-connected projects on the Adafruit Learn System involve using Adafruit IO. For these projects, you must _also_ include your Adafruit IO username and key. Copy the following example, paste it into your settings.toml file, and update: - `your_wifi_ssid` - `your_wifi_password` - `your_aio_username` - `your_aio_key` ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" ADAFRUIT_AIO_USERNAME = "your_aio_username" ADAFRUIT_AIO_KEY = "your_aio_key" ``` Some projects use different variable names for the entries in the **settings.toml** file. For example, a project might use `ADAFRUIT_AIO_ID` in the place of `ADAFRUIT_AIO_USERNAME`. **If you run into connectivity issues, one of the first things to check is that the names in the settings.toml file match the names in the code.** Warning: Not every project uses the same variable name for each entry in the **settings.toml** file! Always verify it matches the code. ## **settings.toml** File Tips Here is an example **settings.toml** file. ```auto # Comments are supported CIRCUITPY_WIFI_SSID = "guest wifi" CIRCUITPY_WIFI_PASSWORD = "guessable" CIRCUITPY_WEB_API_PORT = 80 CIRCUITPY_WEB_API_PASSWORD = "passw0rd" test_variable = "this is a test" thumbs_up = "\U0001f44d" ``` In a **settings.toml** file, it's important to keep these factors in mind: - Strings are wrapped in double quotes; ex: `"your-string-here"` - Integers are _ **not** _ quoted and may be written in decimal with optional sign (`+1`, `-1`, `1000`) or hexadecimal (`0xabcd`). - Floats (decimal numbers), octal (`0o567`) and binary (`0b11011`) are not supported. - Use `\u` escapes for weird characters, `\x` and `\ooo` escapes are not available in **.toml** files - Example: `\U0001f44d` for 👍 (thumbs up emoji) and `\u20ac` for € (EUR sign) - Unicode emoji, and non-ASCII characters, stand for themselves as long as you're careful to save in "UTF-8 without BOM" format     When your  **settings.toml ** file is ready, you can save it in your text editor with the **.toml**  extension. ![adafruit_products_dotToml.jpg](https://cdn-learn.adafruit.com/assets/assets/000/117/071/medium640/adafruit_products_dotToml.jpg?1671034293) ## Accessing Your **settings.toml** Information in **code.py** In your **code.py** file, you'll need to `import` the `os` library to access the **settings.toml** file. Your settings are accessed with the `os.getenv()` function. You'll pass your settings entry to the function to import it into the **code.py** file. ```python import os print(os.getenv("test_variable")) ``` ![](https://cdn-learn.adafruit.com/assets/assets/000/117/072/medium800/adafruit_products_tomlOutput.jpg?1671034496) In the upcoming CircuitPython WiFi examples, you'll see how the **settings.toml ** file is used for connecting to your SSID and accessing your API keys. # PyPortal Air Quality Display ## Internet Connect! # Connect to WiFi OK, now that you have your  **settings.toml** file set up - you can connect to the Internet. To do this, 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 example script. 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 **examples/** 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. Your **CIRCUITPY** drive should now look similar to the following image: ![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/esp32spi_esp32spi_simpletest.py.png ) Info: Update to CircuitPython 9.2.x or later to use this example. https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_simpletest.py And save it to your board, with the name **code.py**. Don't forget you'll also need to create the **settings.toml** file as seen above, with your WiFi ssid and password. In a serial console, you should see something like the following. For more information about connecting with a serial console, view the guide [Connecting to the Serial Console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console). ```terminal >>> import wifitest ESP32 SPI webclient test ESP32 found and in idle mode Firmware vers. 1.7.5 MAC addr: 24:C9:DC:BD:0F:3F HomeNetwork RSSI: -46 HomeNetwork RSSI: -76 Fios-12345 RSSI: -92 FiOS-AB123 RSSI: -92 NETGEAR53 RSSI: -93 Connecting to AP... Connected to HomeNetwork RSSI: -45 My IP address is 192.168.1.245 IP lookup adafruit.com: 104.20.39.240 Ping google.com: 30 ms Fetching text from http://wifitest.adafruit.com/testwifi/index.html ---------------------------------------- This is a test of Adafruit WiFi! If you can read this, its working :) ---------------------------------------- Fetching json from http://wifitest.adafruit.com/testwifi/sample.json ---------------------------------------- {'fun': True, 'company': 'Adafruit', 'founded': 2005, 'primes': [2, 3, 5], 'pi': 3.14, 'mixed': [False, None, 3, True, 2.7, 'cheese']} ---------------------------------------- Done! ``` Going over the example above, here's a breakdown of what the program is doing: - Initialize the ESP32 over SPI using the SPI port and 3 control pins: ```python esp32_cs = DigitalInOut(board.ESP_CS) esp32_ready = DigitalInOut(board.ESP_BUSY) esp32_reset = DigitalInOut(board.ESP_RESET) #... else: spi = busio.SPI(board.SCK, board.MOSI, board.MISO) esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) ``` - Get the socket pool and the SSL context, and then tell the `adafruit_requests` library about them. ```python pool = adafruit_connection_manager.get_radio_socketpool(esp) ssl_context = adafruit_connection_manager.get_radio_ssl_context(esp) requests = adafruit_requests.Session(pool, ssl_context) ``` - Verify an ESP32 is found, checks the firmware and MAC address ```auto if esp.status == adafruit_esp32spi.WL_IDLE_STATUS: print("ESP32 found and in idle mode") print("Firmware vers.", esp.firmware_version) print("MAC addr:", ":".join("%02X" % byte for byte in esp.MAC_address)) ``` - Perform a scan of all access points it can see and print out the name and signal strength. ```python for ap in esp.scan_networks(): print("\t%-23s RSSI: %d" % (ap.ssid, ap.rssi)) ``` - Connect to the AP we've defined here, then print out the local IP address. Then attempt to do a domain name lookup and ping google.com to check network connectivity. (Note sometimes the ping fails or takes a while; this isn't a big deal.) ```python print("Connecting to AP...") while not esp.is_connected: try: esp.connect_AP(ssid, password) except OSError as e: print("could not connect to AP, retrying: ", e) continue print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi) print("My IP address is", esp.ipv4_address) print( "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com")) ) ``` Now we're getting to the really interesting part of the example program. We've written a library for web fetching web data, named [adafruit\_requests](https://github.com/adafruit/Adafruit_CircuitPython_Requests). It is a lot like the regular Python library named [requests](https://requests.readthedocs.io/en/latest/). This library allows you to send HTTP and HTTPS requests easily and provides helpful methods for parsing the response from the server. - Here is the part of the example program is fetching text data from a URL. ```python TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html" # Further up in the program # ... print("Fetching text from", TEXT_URL) r = requests.get(TEXT_URL) print('-' * 40) print(r.text) print('-' * 40) r.close() ``` - Finally, here the program is fetching some JSON data. The `adafruit_requests` library will parse the JSON into a Python dictionary whose structure is the same as the structure of the JSON. ```auto JSON_URL = "http://wifitest.adafruit.com/testwifi/sample.json" # Further up in the program # ... print("Fetching json from", JSON_URL) r = requests.get(JSON_URL) print('-' * 40) print(r.json()) print('-' * 40) r.close() ``` # Advanced Requests Usage Want to send custom HTTP headers, parse the response as raw bytes, or handle a response's http status code in your CircuitPython code? We've written an example to show advanced usage of the requests module below. 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 example script. 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 **examples/** 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_CircuitPython_Requests/blob/main/examples/esp32spi/requests_esp32spi_advanced.py Your **CIRCUITPY** drive should now look similar to the following image: ![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/requests_esp32spi_requests_esp32spi_advanced.py.png ) # WiFi Manager The way the examples above connect to WiFi works but it's a little finicky. Since WiFi is not necessarily so reliable, you may have disconnects and need to reconnect. For more advanced uses, we recommend using the `WiFiManager` class. It will wrap the connection/status/requests loop for you - reconnecting if WiFi drops, resetting the ESP32 if it gets into a bad state, etc. Here's a more advanced example that shows using the `WiFiManager` and also how to fetch the current time from a web source. https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_localtime.py # Further Information For more information on the basics of doing networking in CircuitPython, see this guide: ### Networking in CircuitPython [Networking in CircuitPython](https://learn.adafruit.com/networking-in-circuitpython) # PyPortal Air Quality Display ## Code PyPortal with CircuitPython ## AirNow API Key We'll be using the US government's site [airnow.gov](https://airnow.gov/) to retrieve the air quality index through its API. In order to do so, you'll need to register for an account and get your API key. Go to this [link](https://docs.airnowapi.org/account/request/) and register. Once registered, you'll get an email containing your API key, also known as the "airnow token". Copy and paste this key into your **settings.toml** file that is on the root level of your **CIRCUITPY** drive, so it looks something like this: ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" AIRNOW_TOKEN = "XXX0XXXX-0000-0000-0000-XXXXXXXX0000" ``` Warning: ## Adafruit IO Time Server In order to get the precise time, our project will query the Adafruit IO Internet of Things service for the time. Adafruit IO is absolutely free to use, but you'll need to log in with your Adafruit account to use it. If you don't already have an Adafruit login, create [one here](https://accounts.adafruit.com/users/sign_up). If you haven't used Adafruit IO before, [check out this guide for more info](https://learn.adafruit.com/welcome-to-adafruit-io/getting-started-with-adafruit-io). Once you have logged into your account, there are two pieces of information you'll need to place in your **settings.toml** file: _Adafruit IO username_, and _Adafruit IO key_. Head to [io.adafruit.com](https://io.adafruit.com/) and simply click the _View AIO Key_ link on the left hand side of the Adafruit IO page to get this information. Then, add them to the **settings.toml** file like this: ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" AIRNOW_TOKEN = "XXX0XXXX-0000-0000-0000-XXXXXXXX0000" AIO_USERNAME = "your_aio_username" AIO_KEY = "your_aio_key" ``` ## CircuitPython Code In the embedded code element below, click on the **Download Project Bundle** button, and save the .zip archive file to your computer. Then, uncompress the .zip file, it will unpack to a folder named **PyPortal\_AirQuality**. Copy the contents of the **PyPortal\_AirQuality** directory to your PyPortal **CIRCUITPY** drive. ![](https://cdn-learn.adafruit.com/assets/assets/000/072/502/medium800/wireless_py_airquality_drag.jpg?1552184275) This is what the final contents of the **CIRCUITPY** drive will look like: ![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/PyPortal_PyPortal_AirQuality.png ) https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_AirQuality/code.py Warning: ## How It Works The PyPortal Air Quality Display has a few steps it takes to provide you with the information you desire! Primary: ## WiFi First, the program will connect to the WiFi network specified in the **secrets.py** file. ## API Query and JSON Then, it will send a request to the AirNow URL using your `LOCATION` United States Zip code specified in the code, as well as your AirNow token from the **secrets.py** file. The query looks something like this: `http://www.airnowapi.org/aq/forecast/zipCode/?format=application/json&zipCode=90210&API_KEY=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` (where all of those 'x's are your token). When this query is complete, it returns a JSON file that looks like this: ``` [ { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-10 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "O3", "AQI": 32, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-10 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "PM2.5", "AQI": 33, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-10 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "PM10", "AQI": 7, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-10 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "NO2", "AQI": 22, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-10 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "CO", "AQI": 5, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-11 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "O3", "AQI": 29, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-11 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "PM2.5", "AQI": 33, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-11 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "PM10", "AQI": 9, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-11 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "NO2", "AQI": 18, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false }, { "DateIssue": "2019-03-09 ", "DateForecast": "2019-03-11 ", "ReportingArea": "NW Coastal LA", "StateCode": "CA", "Latitude": 34.0505, "Longitude": -118.4566, "ParameterName": "CO", "AQI": 6, "Category": { "Number": 1, "Name": "Good" }, "ActionDay": false } ] ``` You can use online code "beautifiers" such as [https://codebeautify.org/jsonviewer](https://codebeautify.org/jsonviewer) or [http://jsonviewer.stack.hu](http://jsonviewer.stack.hu) to get a nice hierarchical view of the data in the JSON file: ![](https://cdn-learn.adafruit.com/assets/assets/000/072/505/medium800/wireless_airnowbeauty.png?1552194110) ## JSON Traversal The JSON file is formatted in a way that makes it easy to traverse the hierarchy and parse the data. In it, you'll see keys, such as `DateIssue`, `ReportingArea`, `ParameterName`, and `AQI`, and their respective values. The **key : value** pair we care about for the Air Quality Display is the Air Quality Index of particle pollution (PM2.5), or **AQI**. This is the pair: - `"AQI" : "33"````` In order to fetch this data from the file, we need to be able to describe their locations in the file hierarchically. This is helpful, for example, in differentiating between the `'AQI'` in the `'PM2.5'` section vs. the '`AQI'` in the `'NO2'` section. To avoid name clashing we rely on JSON traversal. In the **airquality.py** file, you'll see how this is done. For example, the key we want for PM2.5 is found in this hierarchy of the JSON file: `[1, "AQI"]` This means there is a sub-tree to the top level of the file indexed `[1]`, which is the second section, as the first is indexed zero. Then, below that level is the `'AQI'` key we want. The value of that key in this case is `'33'` which is considered to be in the "good" range of particle pollution. ### Background For the background, it displays a solid color based on the current air quality index value. 0-50 is considered good, for example, and has a green background. Here is the full set: - 0-50, "good", green - 51-100, "moderate", yellow - 101-150, "sensitive", orange - 151-200 "unhealthy", red - 210-300, "very unhealthy", purple - 301-500, "hazardous", maroon ### Font The AQI value is displayed as text created with a bitmapped font to overlay on top of the background. The fonts used here are bitmap fonts made from the Helvetica typeface. You can learn more about [converting type in this guide](https://learn.adafruit.com/custom-fonts-for-pyportal-circuitpython-display). At the bottom of the screen, there is a caption text that types out **"Air Quality Index for "** followed by the United States Zip code you entered. ## PyPortal Constructor When we set up the `pyportal` constructor, we are providing it with these things: - `url` to query - `json_path` to traverse and find the key:value pair we need - `default_bg` default background color - details of text and caption fonts, positions, and colors ## Fetch With the PyPortal set up, we can then use `pyportal.fetch()` to do the query and parsing of the AirNow data and then display it on screen. ## Text Position Depending on the design of your background bitmap and the length of the text you're displaying, you may want to reposition the text and caption. You can do this with the `text_position` and `caption_position` options. The PyPortal's display is 320 pixels wide and 240 pixels high. In order to refer to those positions on the screen, we use an x/y coordinate system, where x is horizontal and y is vertical. The origin of this coordinate system is the upper left corner. This means that a pixel placed at the upper left corner would be (0,0) and the lower right corner would be (320, 240). ![](https://cdn-learn.adafruit.com/assets/assets/000/072/123/medium800/internet_of_things___iot_pyportal_grid.jpg?1551460792) So, if you wanted to move the subscriber count text to the right and up closer to the top, your code may look like this for that part of the pyportal constructor: `text_position=(250, 10)` ## Text Color Another way to customize your display is to adjust the color of the text. The line `text_color=0xFFFFFF` in the constructor shows how. You will need to use the hexadecimal value for any color you want to display. You can use something like [https://htmlcolorcodes.com/](https://htmlcolorcodes.com/) to pick your color and then copy the hex value, in this example it would be `0x0ED9EE` ![](https://cdn-learn.adafruit.com/assets/assets/000/072/129/medium800/internet_of_things___iot_hecxolor.png?1551462671) Now, we'll look at mounting the PyPortal into a case for display! # PyPortal Air Quality Display ## PyPortal Air Quality Display Case ![](https://cdn-learn.adafruit.com/assets/assets/000/072/500/medium800/wireless_airIMG_4419_2k.jpg?1552183395) I decided to use the portable PyPortal case designed by the Ruiz Bros. as my enclosure. [You can go to this guide to build it](https://learn.adafruit.com/pyportal-case/overview) -- either by 3D printing it yourself or sending out to a service such as 3DHubs. ![](https://cdn-learn.adafruit.com/assets/assets/000/072/462/medium800/weather_IMG_4418_2k.jpg?1552076204) I didn't need this to be portable, so I omitted the PowerBoost, battery, speaker, and switch. ![](https://cdn-learn.adafruit.com/assets/assets/000/072/463/medium800/weather_IMG_4417_2k.jpg?1552076234) I used all of the same 3D parts, and screwed the mount together, then snapped the top and bottom into place. ![](https://cdn-learn.adafruit.com/assets/assets/000/072/464/medium800/weather_IMG_4416_2k.jpg?1552076252) ## Magnets I wanted to mount my PyPortal on my refrigerator, so I affixed magnets. ## Magnets   Use a piece of double stick foam tape to secure the magnetic pin back to the case as shown. ![weather_IMG_4420_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/465/medium640/weather_IMG_4420_2k.jpg?1552076538) ![weather_IMG_4422_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/466/medium640/weather_IMG_4422_2k.jpg?1552076551) ![weather_IMG_4424_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/467/medium640/weather_IMG_4424_2k.jpg?1552076559) ![](https://cdn-learn.adafruit.com/assets/assets/000/072/469/medium800/weather_IMG_4426_2k.jpg?1552076690) I tested it on my workbench drawer and it worked great! Time to place it on the fridge and plug it in! ![](https://cdn-learn.adafruit.com/assets/assets/000/072/499/medium800/wireless_airIMG_4431_2k.jpg?1552183217) ![](https://cdn-learn.adafruit.com/assets/assets/000/072/498/medium800/wireless_airIMG_4433_2k.jpg?1552183063) Now, every ten minutes, your display will update with the latest Air Quality Index data. Pay attention if it turns orange or red for the background color -- you may want to change your air filters and be careful outside. ## Featured Products ### Adafruit PyPortal - CircuitPython Powered Internet Display [Adafruit PyPortal - CircuitPython Powered Internet Display](https://www.adafruit.com/product/4116) **PyPortal** , our easy-to-use IoT device that allows you to create all the things for the “Internet of Things” in minutes. Make custom touch screen interface GUIs, all open-source, and Python-powered using tinyJSON / APIs to get news, stock, weather, cat photos,... Out of Stock [Buy Now](https://www.adafruit.com/product/4116) [Related Guides to the Product](https://learn.adafruit.com/products/4116/guides) ### 5V 2A Switching Power Supply w/ USB-A Connector [5V 2A Switching Power Supply w/ USB-A Connector](https://www.adafruit.com/product/1994) Our 5V 2A USB power adapter is the perfect choice for powering single-board computers like Raspberry Pi, BeagleBone, or anything else that's power-hungry! This adapter was specifically designed to provide 5.25V, not 5V, but we still call it a 5V USB adapter. We did this on purpose to... In Stock [Buy Now](https://www.adafruit.com/product/1994) [Related Guides to the Product](https://learn.adafruit.com/products/1994/guides) ### USB A/Micro Cable - 2m [USB A/Micro Cable - 2m](https://www.adafruit.com/product/2185) This is your standard USB A-Plug to Micro-USB cable. It's 2 meters long so you'll have plenty of cord to work with for those longer extensions. Out of Stock [Buy Now](https://www.adafruit.com/product/2185) [Related Guides to the Product](https://learn.adafruit.com/products/2185/guides) ### Black Nylon Machine Screw and Stand-off Set – M2.5 Thread [Black Nylon Machine Screw and Stand-off Set – M2.5 Thread](https://www.adafruit.com/product/3299) Totaling 380 pieces, this **M2.5 Screw Set**  is a must-have for your workstation. You'll have enough screws, nuts, and hex standoffs to fuel your maker tendencies for days on end! M2.5 size screws fit almost all of the Adafruit breakout/dev board mounting holes... In Stock [Buy Now](https://www.adafruit.com/product/3299) [Related Guides to the Product](https://learn.adafruit.com/products/3299/guides) ### Magnetic Pin Back [Magnetic Pin Back](https://www.adafruit.com/product/1170) These magnetic pin backs have two pieces: a metal bar with adhesive strip and a plastic piece with two strong rare-earth magnets. Affix the metal bar to your FLORA projects-- it's just the right size! Then attach your FLORA project to any garment without poking holes in your clothes. The... In Stock [Buy Now](https://www.adafruit.com/product/1170) [Related Guides to the Product](https://learn.adafruit.com/products/1170/guides) ### PLA Filament for 3D Printers - 2.85mm Diameter - Lilac - 1 Kg [PLA Filament for 3D Printers - 2.85mm Diameter - Lilac - 1 Kg](https://www.adafruit.com/product/3733) Having a 3D printer without filament is sort of like having a regular printer without paper or ink. And while a lot of printers come with some filament there's a good chance you've been printing up a storm and want something new.  That's why we carry 3D printing... No Longer Stocked [Buy Now](https://www.adafruit.com/product/3733) [Related Guides to the Product](https://learn.adafruit.com/products/3733/guides) ### Ultimaker 2+ 3D Printer [Ultimaker 2+ 3D Printer](https://www.adafruit.com/product/2673) The **Ultimaker 2+** is one of our favorite 3D printers on the market. It's a well-built open-source compact machine with an excellent UX. Every inch of the Ultimaker 2+ is designed to create the most effortless and reliable 3D printing experience ever!  No Longer Stocked [Buy Now](https://www.adafruit.com/product/2673) [Related Guides to the Product](https://learn.adafruit.com/products/2673/guides) ## Related Guides - [Adafruit PyPortal - IoT for CircuitPython](https://learn.adafruit.com/adafruit-pyportal.md) - [CircuitPython Powered Sip & Puff with ST LPS33HW Pressure Sensor](https://learn.adafruit.com/st-lps33-and-circuitpython-sip-and-puff.md) - [CircuitPython OLED Watch Clock](https://learn.adafruit.com/circuitpython-oled-watch.md) - [Welcome to CircuitPython!](https://learn.adafruit.com/welcome-to-circuitpython.md) - [ESP32-S3 BLE RS-232 Controller](https://learn.adafruit.com/esp32-s3-ble-rs232-controller.md) - [Arcade Bonnet Controller](https://learn.adafruit.com/arcade-bonnet-controller.md) - [Portable PyPortal](https://learn.adafruit.com/portable-pyportal.md) - [AS5600 Super Smooth Rotary Encoder](https://learn.adafruit.com/as5600-smooth-rotary-encoder.md) - [A Logger for CircuitPython](https://learn.adafruit.com/a-logger-for-circuitpython.md) - [PyPortal IoT Data Logger with Analog Devices ADT7410, Adafruit IO and CircuitPython](https://learn.adafruit.com/iot-pyportal-data-logger-adafruitio-circuitpython.md) - [CircuitPython Twitter Viewer Using the Twitter API](https://learn.adafruit.com/twitter-api-use.md) - [Getting Started with Braille Output for CircuitPython REPL](https://learn.adafruit.com/getting-started-braille-output-circuitpython-repl.md) - [Getting Started with Microsoft Azure and CircuitPython](https://learn.adafruit.com/getting-started-with-microsoft-azure-and-circuitpython.md) - [PyPaint Drawing Program In CircuitPython](https://learn.adafruit.com/pypaint.md) - [How to Make Animated Graphics for Hologram Displays](https://learn.adafruit.com/how-to-make-animated-graphics-for-hologram-displays.md) - [League of Legends Level Trophy for PyPortal](https://learn.adafruit.com/league-of-legends-level-trophy-for-pyportal.md)