Skip to main content
Where's My Friend? A Location-Aware Display with PyPortal and ItsASnap

Where's My Friend? A Location-Aware Display with PyPortal and ItsASnap

Image for user brubell
by Brent Rubell
published August 07, 2024, last updated October 03, 2024
posted in Adafruit Products LCDs & Displays Internet of Things - IOT Programming/ MicroPython / CircuitPython Breakout Boards/ WiFi
Save Subscribe Download
1
New
Beginner
Project guide

Overview

adafruit_products_BEE9B909-86F5-4C23-A449-240118CC450A_1_201_a.jpeg

Where's my friend? Build this simple IoT project to display a friend's or loved one's location on an Adafruit PyPortal. 

Using Adafruit's ItsaSnap iOS app and Apple Shortcuts, you can send a pre-selected GPS location from an iPhone to a shared (private) Adafruit IO feed. The PyPortal connects to the internet, fetches a location value of a shared feed, and displays the location on the screen along with a corresponding icon and text.

About this project, your privacy, and Adafruit IO

Adafruit IO's data feeds are private (not viewable by others) by default and secure (we will never sell or give this data away to another company).

This project uses the ItsaSnap iOS App to bridge Adafruit IO and Apple Shortcuts. Apple Shortcuts utilizes your iPhone's GPS (with permission) to write a string of text (i.e.: "park" or "work") to identify where a friend is. It does not send specific GPS location data to the Adafruit IO servers.

The data sent by the Shortcuts app is stored on a private Adafruit IO data feed, only viewable by you and the friend sharing their location with you. 

adafruit_products_adafruit_io_ezgif.com-optijpeg.png

ItsaSnap for iOS

It's a Snap (ItsaSnap) is a simple iOS app designed for exploring Adafruit IO. It allows you to send data to your Adafruit IO feeds. You can also link it to control or monitor your internet-connected projects. This lets you control and check Adafruit devices from your phone, anywhere. 

It also allows us to use Apple's Shortcuts app to create a code-free automation from your iOS device.

Parts

The following products and parts are required to complete this project:

Note: The code in this guide is designed for the original Adafruit PyPortal. If you have the PyPortal Pynt or PyPortal Titano, you can still complete this project, but you will need to adjust some of the code to accommodate the Titano/Pynt's different display sizes.

Front view of a Adafruit PyPortal - CircuitPython Powered Internet Display with a pyportal logo image on the display.
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...
guides with product
Out of Stock
Out of Stock
1 x USB cable - USB A to Micro-B
USB cable - USB A to Micro-B - 3 foot long

The following parts are not required to complete this project but are nice to have.

Assembled PyPortal in acrylic enclosure
PyPortal is our easy-to-use IoT device that allows you to create all the things for the “Internet of Things” in minutes. Create little pocket...
$9.95
In Stock
Add to Cart
1 x Adafruit IO+ One Year Subscription
Adafruit IO+ Subscription Pass – One Year

Text editor powered by tinymce.

Adafruit IO is integrated with your adafruit.com account so you don't need to create yet another online account! You need an Adafruit account to use Adafruit IO because we want to make sure the data you upload is available to only you (unless you decide to publish your data).

I have an Adafruit.com Account already

If you already have an Adafruit account, then you already have access to Adafruit IO. It doesn't matter how you signed up, your account will make all three available.

To access Adafruit IO, simply visit https://io.adafruit.com to start streaming, logging, and interacting with your data.

Create an Adafruit Account (for Adafruit IO)

An Adafruit account makes Adafruit content and services available to you in one place. Your account provides access to the Adafruit shop, the Adafruit Learning System, and Adafruit IO. This means only one account, one username, and one password are necessary to engage with the content and services that Adafruit offers.

If you do not have an Adafruit account, signing up for a new Adafruit account only takes a couple of steps.

Begin by visiting https://accounts.adafruit.com.

Click the Sign Up button under the "Need An Adafruit Account?" title, below the Sign In section.

adafruit_io_Create_account_sign_in_up_page.png

This will take you to the Sign Up page.

Fill in the requested information, and click the Create Account button.

adafruit_io_Create_Account_info_entered.png

This takes you to your Adafruit Account home page. From here, you can access all the features of your account.

You can also access the Adafruit content and services right from this page. Along the top of the page, you'll see a series of links beginning with "Shop". To access any of these, simply click the link.

adafruit_io_Create_account_home_page.png

For example, to begin working with Adafruit IO, click the IO link to the right of the rest of the links. This is the same for the other links as well.

That's all there is to creating a new Adafruit account, and navigating to Adafruit IO.

adafruit_io_Create_Account_io_homepage.png

Text editor powered by tinymce.

Create a new Shared Adafruit IO Feed

Adafruit IO's feed-sharing feature allows you to invite someone to view (or write to) a specific feed. This is a great feature if you're building a project but don't want to make your feed public to strangers, only your friends. In this project, the person sharing their location will create a shared feed and invite the person with the PyPortal to view it.

In a web browser, navigate to io.adafruit.com/feeds and click "+ New Feed"

adafruit_products_newfeed.png

Give your new feed a name. The description is optional. Click Create to create the new feed.

adafruit_products_iofeedslocation.png

Under My Feeds, you should see the location feed you created. Click the link to be brought to the Feed's page.

adafruit_products_location-feed-click.png

On the feed page, click the Sharing text on the sidebar

adafruit_products_location-feed-sharing.png

You'll be greeted with the Sharing Settings window.

adafruit_products_sharingsettings.png

You can invite somebody you know using their Adafruit IO Username or email address. You'll have two options for controlling someone's access to your feed:

  1. If you give someone Read access, they can view the feed you share.
  2. If you give someone Read + Write access, they can read from your feed and write to your feed. 

For this project, the PyPortal only needs to display the feed's last value.

Enter your friend's email or Adafruit IO username, give them the Read Access Level, and click Send Invitation.

adafruit_products_adafruit_io_invite.png

Accepting a Shared Feed Request

Now it's the other person's turn. After you click Send Invitation, they should receive an email from Adafruit IO informing them that you've shared a feed. After they've reviewed and accepted it, move on to the next page.

adafruit_products_adafruit_io_brent_has_shared_a_feed_with_you_on_Adafruit_IO__-_brentrubell_gmail_com_-_Gmail.png

Text editor powered by tinymce.

This section will guide you through downloading and installing the ItsaSnap by Adafruit app.

Download and Install ItsaSnap

To install and download ItsaSnap for your iOS device,

  1. Open the App Store.
  2. Tap on the "Search" icon at the bottom of the screen.
  3. Type "ItsaSnap by Adafruit" or "ItsaSnap" in the search bar and tap "Search".
  4. Locate the ItsaSnap app in the search results and tap on it
adafruit_io_IMG_5711-ezgif.com-resize-2.jpg

    5. Tap the "Get" button to download and install the app on your device. 

You may be prompted to enter your Apple ID password or use Face ID/Touch ID to confirm the installation

adafruit_io_IMG_5711-ezgif.com-resize-crop.jpg

After you have downloaded and installed ItsaSnap, open the app.

adafruit_io_adaSnap5-ezgif.com-resize.png

You will need to enter your Adafruit username and Adafruit IO Key (which is different from your Adafruit account password).

Your Adafruit IO key is a long string of letters and numbers. To make it easier to add to the app, we've also included a QR code scanner that allows you to easily copy the Adafruit IO Key from the Adafruit IO website to the app.

adafruit_io_qrbuttonscan.png

On the ItaSnap app, the QR code scanner is located below the Adafruit IO Key and above the login button. To access it, press the 'Scan QR code for IO Key' button. This will open the QR code scanner.

adafruit_io_IMG_5702-ezgif.com-crop.png

To find the QR code for your Adafruit IO account, navigate go to the overview page. Once there, click the yellow button with a key in the center (it's next to the "New Device" button) to reveal your Adafruit IO Key. 

adafruit_io_Screenshot_2024-06-10_at_9.42.20 PM.png

After clicking it, a window with your information will appear. Then, find the QR code and scan it, and log in.

adafruit_io_Pasted_Image_6_11_24__11_55_AM.png

Text editor powered by tinymce.

Apple Shortcuts are only available in the latest version of It'saSnap By Adafruit.

ItsASnap includes several actions for the Apple Shortcuts App, allowing you to integrate Adafruit IO functionality. This project focuses on sending specific location data (only sending data when you're at a fixed location, like a park or the train station) from your iPhone to a shared Adafruit IO feed. 

This step will demonstrate how to use ItsASnap with Apple Shortcuts to send a value to an Adafruit IO feed when you arrive at a location - in this instance, we'll choose a park. 

Create a new Shortcuts Automation

Launch Apple Shortcuts. To create a new automation, go to the automation screen and tap the "+" button. 

adafruit_products_adafruit_io_IMG_6177.jpg

Here you can select which types of triggers can initiate an action. For now, we'll use "Arrive" to set a location where the action will be triggered.

Select "Arrive" as the trigger for the automation. This trigger requires a specific location to initiate the automation process.

adafruit_products_arrive.png

We'll want to track when we're at work. Add the work location (I work for Adafruit so I added the Adafruit HQ) into the location field; it will then be displayed on the map. 

Additionally, you can configure the radius of the location to specify where you want the trigger to activate.

Once you're all set - tap Done.

adafruit_products_IMG_1494.png

Configure your When action is configured to execute at any time and run immediately. Tap Next.

adafruit_products_timerange.png

On the next step, tap New Blank Automation to configure ItsaSnap.

adafruit_products_IMG_1498.png

Within the Blank Automation tab, use the search bar to search for ItsaSnap. Then, select the Send Value shortcut.

adafruit_products_search_select.png
adafruit_products_IMG_1500_2.png
adafruit_products_IMG_1500_2.png
adafruit_products_work-feed.png

Select the Value by tapping on it. Enter Work for the value. 

adafruit_products_feedloc.png
adafruit_products_feedloc.png
adafruit_products_feeddone.png

Set the Feed value to the Feed's Key and tap Done.

Once done, you should be able to view the automation.

Add more Shortcuts for Different Locations

While adding one automation for the park is useful - there are other places your friend goes during his day like work, home, and commuting via the NYC Subway.

You can repeat the process above to add more shortcuts for different locations. For each location shortcut you configure, ensure the feed being written to is the location feed.

For this guide, we created the following four automation using the following settings:

  • The value home to the location feed when we've arrived home.
  • The value work to the location feed when we've arrived at work
  • The value commute to the location feed when we've left work.
  • The value gym to the location feed when we've arrived at the park to workout.
adafruit_products_automation-list.png

Text editor powered by tinymce.

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:

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.

Text editor powered by tinymce.

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, 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.

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
Download File
Copy Code 
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
Download File
Copy Code 
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.

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.

Download File
Copy Code 
# 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, 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
adafruit_products_dotToml.jpg

 

 

When your settings.toml file is ready, you can save it in your text editor with the .toml extension.

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.

Download File
Copy Code 
import os

print(os.getenv("test_variable"))
adafruit_products_tomlOutput.jpg

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.

Text editor powered by tinymce.

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

If you are using CircuitPython 9.0.x on a board with frozen libraries, such the Matrix Portal M4, use this version of the "Internet Connect" program. If you are using CircuitPython 9.1.0 or later, use the second version below.
Download Project Bundle
Copy Code 
# SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries
# SPDX-License-Identifier: MIT

from os import getenv
import board
import busio
from digitalio import DigitalInOut
import adafruit_connection_manager
import adafruit_requests
from adafruit_esp32spi import adafruit_esp32spi

# Get wifi details and more from a settings.toml file
# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
secrets = {
    "ssid": getenv("CIRCUITPY_WIFI_SSID"),
    "password": getenv("CIRCUITPY_WIFI_PASSWORD"),
}
if secrets == {"ssid": None, "password": None}:
    try:
        # Fallback on secrets.py until depreciation is over and option is removed
        from secrets import secrets
    except ImportError:
        print("WiFi secrets are kept in settings.toml, please add them there!")
        raise

print("ESP32 SPI webclient test")

TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
JSON_URL = "http://api.coindesk.com/v1/bpi/currentprice/USD.json"


# If you are using a board with pre-defined ESP32 Pins:
esp32_cs = DigitalInOut(board.ESP_CS)
esp32_ready = DigitalInOut(board.ESP_BUSY)
esp32_reset = DigitalInOut(board.ESP_RESET)

# If you have an AirLift Shield:
# esp32_cs = DigitalInOut(board.D10)
# esp32_ready = DigitalInOut(board.D7)
# esp32_reset = DigitalInOut(board.D5)

# If you have an AirLift Featherwing or ItsyBitsy Airlift:
# esp32_cs = DigitalInOut(board.D13)
# esp32_ready = DigitalInOut(board.D11)
# esp32_reset = DigitalInOut(board.D12)

# If you have an externally connected ESP32:
# NOTE: You may need to change the pins to reflect your wiring
# esp32_cs = DigitalInOut(board.D9)
# esp32_ready = DigitalInOut(board.D10)
# esp32_reset = DigitalInOut(board.D5)

# Secondary (SCK1) SPI used to connect to WiFi board on Arduino Nano Connect RP2040
if "SCK1" in dir(board):
    spi = busio.SPI(board.SCK1, board.MOSI1, board.MISO1)
else:
    spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)

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)

if esp.status == adafruit_esp32spi.WL_IDLE_STATUS:
    print("ESP32 found and in idle mode")
print("Firmware vers.", esp.firmware_version.decode("utf-8"))
print("MAC addr:", ":".join("%02X" % byte for byte in esp.MAC_address))

for ap in esp.scan_networks():
    print("\t%-23s RSSI: %d" % (str(ap["ssid"], "utf-8"), ap["rssi"]))

print("Connecting to AP...")
while not esp.is_connected:
    try:
        esp.connect_AP(secrets["ssid"], secrets["password"])
    except OSError as e:
        print("could not connect to AP, retrying: ", e)
        continue
print("Connected to", str(esp.ssid, "utf-8"), "\tRSSI:", esp.rssi)
print("My IP address is", esp.pretty_ip(esp.ip_address))
print(
    "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com"))
)
print("Ping google.com: %d ms" % esp.ping("google.com"))

# esp._debug = True
print("Fetching text from", TEXT_URL)
r = requests.get(TEXT_URL)
print("-" * 40)
print(r.text)
print("-" * 40)
r.close()

print()
print("Fetching json from", JSON_URL)
r = requests.get(JSON_URL)
print("-" * 40)
print(r.json())
print("-" * 40)
r.close()

print("Done!")
View on GitHub

If you are using CircuitPython 9.1.0, or using the latest version of the ESP32SPI library, using the version below. If you are using CircuitPython 9.0.x on a board with frozen libraries, such as the Matrix Portal M4, use the first version above.
Download Project Bundle
Copy Code 
# SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries
# SPDX-License-Identifier: MIT

from os import getenv
import board
import busio
from digitalio import DigitalInOut
import adafruit_connection_manager
import adafruit_requests
from adafruit_esp32spi import adafruit_esp32spi

# Get wifi details and more from a settings.toml file
# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
secrets = {
    "ssid": getenv("CIRCUITPY_WIFI_SSID"),
    "password": getenv("CIRCUITPY_WIFI_PASSWORD"),
}
if secrets == {"ssid": None, "password": None}:
    try:
        # Fallback on secrets.py until depreciation is over and option is removed
        from secrets import secrets
    except ImportError:
        print("WiFi secrets are kept in settings.toml, please add them there!")
        raise

print("ESP32 SPI webclient test")

TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
JSON_URL = "http://api.coindesk.com/v1/bpi/currentprice/USD.json"


# If you are using a board with pre-defined ESP32 Pins:
esp32_cs = DigitalInOut(board.ESP_CS)
esp32_ready = DigitalInOut(board.ESP_BUSY)
esp32_reset = DigitalInOut(board.ESP_RESET)

# If you have an AirLift Shield:
# esp32_cs = DigitalInOut(board.D10)
# esp32_ready = DigitalInOut(board.D7)
# esp32_reset = DigitalInOut(board.D5)

# If you have an AirLift Featherwing or ItsyBitsy Airlift:
# esp32_cs = DigitalInOut(board.D13)
# esp32_ready = DigitalInOut(board.D11)
# esp32_reset = DigitalInOut(board.D12)

# If you have an externally connected ESP32:
# NOTE: You may need to change the pins to reflect your wiring
# esp32_cs = DigitalInOut(board.D9)
# esp32_ready = DigitalInOut(board.D10)
# esp32_reset = DigitalInOut(board.D5)

# Secondary (SCK1) SPI used to connect to WiFi board on Arduino Nano Connect RP2040
if "SCK1" in dir(board):
    spi = busio.SPI(board.SCK1, board.MOSI1, board.MISO1)
else:
    spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)

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)

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))

for ap in esp.scan_networks():
    print("\t%-23s RSSI: %d" % (ap.ssid, ap.rssi))

print("Connecting to AP...")
while not esp.is_connected:
    try:
        esp.connect_AP(secrets["ssid"], secrets["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"))
)
print("Ping google.com: %d ms" % esp.ping("google.com"))

# esp._debug = True
print("Fetching text from", TEXT_URL)
r = requests.get(TEXT_URL)
print("-" * 40)
print(r.text)
print("-" * 40)
r.close()

print()
print("Fetching json from", JSON_URL)
r = requests.get(JSON_URL)
print("-" * 40)
print(r.json())
print("-" * 40)
r.close()

print("Done!")
View on GitHub

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.

circuitpython_image.png

In order, the example code...

Initializes the ESP32 over SPI using the SPI port and 3 control pins:

Download File
Copy Code 
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)

Gets the socket pool and the SSL context, and then tells the adafruit_requests library about them.

Download File
Copy Code 
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)

Verifies an ESP32 is found, checks the firmware and MAC address

Download File
Copy Code 
if esp.status == adafruit_esp32spi.WL_IDLE_STATUS:
    print("ESP32 found and in idle mode")
print("Firmware vers.", esp.firmware_version)
print("MAC addr:", [hex(i) for i in esp.MAC_address])

Performs a scan of all access points it can see and prints out the name and signal strength:

Download File
Copy Code 
for ap in esp.scan_networks():
    print("\t%s\t\tRSSI: %d" % (str(ap['ssid'], 'utf-8'), ap['rssi']))

Connects to the AP we've defined here, then prints out the local IP address, attempts 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)

Download File
Copy Code 
print("Connecting to AP...")
while not esp.is_connected:
    try:
        esp.connect_AP(secrets["ssid"], secrets["password"])
    except RuntimeError as e:
        print("could not connect to AP, retrying: ", e)
        continue
print("Connected to", str(esp.ssid, "utf-8"), "\tRSSI:", esp.rssi)
print("My IP address is", esp.pretty_ip(esp.ip_address))
print(
    "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com"))

OK now we're getting to the really interesting part. With a SAMD51 or other large-RAM (well, over 32 KB) device, we can do a lot of neat tricks. Like for example we can implement an interface a lot like requests - which makes getting data really really easy

To read in all the text from a web URL call requests.get - you can pass in https URLs for SSL connectivity

Download File
Copy Code 
TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
print("Fetching text from", TEXT_URL)
r = requests.get(TEXT_URL)
print('-'*40)
print(r.text)
print('-'*40)
r.close()

Or, if the data is in structured JSON, you can get the json pre-parsed into a Python dictionary that can be easily queried or traversed. (Again, only for nRF52840, M4 and other high-RAM boards)

Download File
Copy Code 
JSON_URL = "http://api.coindesk.com/v1/bpi/currentprice/USD.json"
print("Fetching json from", JSON_URL)
r = requests.get(JSON_URL)
print('-'*40)
print(r.json())
print('-'*40)
r.close()

Requests

We've written a requests-like library for web interfacing named Adafruit_CircuitPython_Requests. This library allows you to send HTTP/1.1 requests without "crafting" them and provides helpful methods for parsing the response from the server.

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.

Your CIRCUITPY drive should now look similar to the following image:

CIRCUITPY
Download Project Bundle
Copy Code 
Temporarily unable to load content:
View on GitHub

The code first sets up the ESP32SPI interface. Then, it initializes a request object using an ESP32 socket and the esp object.

Download File
Copy Code 
import board
import busio
from digitalio import DigitalInOut
import adafruit_esp32spi.adafruit_esp32spi_socket as socket
from adafruit_esp32spi import adafruit_esp32spi
import adafruit_connection_manager
import adafruit_requests as requests

# If you are using a board with pre-defined ESP32 Pins:
esp32_cs = DigitalInOut(board.ESP_CS)
esp32_ready = DigitalInOut(board.ESP_BUSY)
esp32_reset = DigitalInOut(board.ESP_RESET)

# If you have an externally connected ESP32:
# esp32_cs = DigitalInOut(board.D9)
# esp32_ready = DigitalInOut(board.D10)
# esp32_reset = DigitalInOut(board.D5)

spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)

print("Connecting to AP...")
while not esp.is_connected:
    try:
        esp.connect_AP(b'MY_SSID_NAME', b'MY_SSID_PASSWORD')
    except RuntimeError as e:
        print("could not connect to AP, retrying: ",e)
        continue
print("Connected to", str(esp.ssid, 'utf-8'), "\tRSSI:", esp.rssi)

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)

HTTP GET with Requests

The code makes a HTTP GET request to Adafruit's WiFi testing website - http://wifitest.adafruit.com/testwifi/index.html.

To do this, we'll pass the URL into requests.get(). We're also going to save the response from the server into a variable named response.

Having requested data from the server, we'd now like to see what the server responded with. Since we already saved the server's response, we can read it back. Luckily for us, requests automatically decodes the server's response into human-readable text, you can read it back by calling response.text.

Lastly, we'll perform a bit of cleanup by calling response.close(). This closes, deletes, and collect's the response's data. 

Download File
Copy Code 
print("Fetching text from %s"%TEXT_URL)
response = requests.get(TEXT_URL)
print('-'*40)

print("Text Response: ", response.text)
print('-'*40)
response.close()

While some servers respond with text, some respond with json-formatted data consisting of attribute–value pairs.

CircuitPython_Requests can convert a JSON-formatted response from a server into a CPython dict. object.

We can also fetch and parse json data. We'll send a HTTP get to a url we know returns a json-formatted response (instead of text data). 

Then, the code calls response.json() to convert the response to a CPython dict. 

Download File
Copy Code 
print("Fetching JSON data from %s"%JSON_GET_URL)
response = requests.get(JSON_GET_URL)
print('-'*40)

print("JSON Response: ", response.json())
print('-'*40)
response.close()

HTTP POST with Requests

Requests can also POST data to a server by calling the requests.post method, passing it a data value.

Download File
Copy Code 
data = '31F'
print("POSTing data to {0}: {1}".format(JSON_POST_URL, data))
response = requests.post(JSON_POST_URL, data=data)
print('-'*40)

json_resp = response.json()
# Parse out the 'data' key from json_resp dict.
print("Data received from server:", json_resp['data'])
print('-'*40)
response.close()

You can also post json-formatted data to a server by passing json_data into the requests.post method.

Download File
Copy Code 
    json_data = {"Date" : "July 25, 2019"}
print("POSTing data to {0}: {1}".format(JSON_POST_URL, json_data))
response = requests.post(JSON_POST_URL, json=json_data)
print('-'*40)

json_resp = response.json()
# Parse out the 'json' key from json_resp dict.
print("JSON Data received from server:", json_resp['json'])
print('-'*40)
response.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.

Your CIRCUITPY drive should now look similar to the following image:

CIRCUITPY
Download Project Bundle
Copy Code 
Temporarily unable to load content:
View on GitHub

WiFi Manager

That simpletest example works but it's a little finicky - you need to constantly check WiFi status and have many loops to manage connections and disconnections. For more advanced uses, we recommend using the WiFiManager object. 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 the WiFi manager and also how to POST data with some extra headers:

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.

Your CIRCUITPY drive should now look similar to the following image:

CIRCUITPY
Download Project Bundle
Copy Code 
# SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries
# SPDX-License-Identifier: MIT

import time
from os import getenv
import board
import busio
from digitalio import DigitalInOut
import neopixel
from adafruit_esp32spi import adafruit_esp32spi
from adafruit_esp32spi import adafruit_esp32spi_wifimanager

print("ESP32 SPI webclient test")

# Get wifi details and more from a settings.toml file
# tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
#                           CIRCUITPY_AIO_USERNAME, CIRCUITPY_AIO_KEY
secrets = {}
for token in ["ssid", "password"]:
    if getenv("CIRCUITPY_WIFI_" + token.upper()):
        secrets[token] = getenv("CIRCUITPY_WIFI_" + token.upper())
for token in ["aio_username", "aio_key"]:
    if getenv("CIRCUITPY_" + token.upper()):
        secrets[token] = getenv("CIRCUITPY_" + token.upper())

if not secrets:
    try:
        # Fallback on secrets.py until depreciation is over and option is removed
        from secrets import secrets
    except ImportError:
        print("WiFi secrets are kept in settings.toml, please add them there!")
        raise

# If you are using a board with pre-defined ESP32 Pins:
esp32_cs = DigitalInOut(board.ESP_CS)
esp32_ready = DigitalInOut(board.ESP_BUSY)
esp32_reset = DigitalInOut(board.ESP_RESET)

# If you have an externally connected ESP32:
# esp32_cs = DigitalInOut(board.D9)
# esp32_ready = DigitalInOut(board.D10)
# esp32_reset = DigitalInOut(board.D5)

# Secondary (SCK1) SPI used to connect to WiFi board on Arduino Nano Connect RP2040
if "SCK1" in dir(board):
    spi = busio.SPI(board.SCK1, board.MOSI1, board.MISO1)
else:
    spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
"""Use below for Most Boards"""
status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
"""Uncomment below for ItsyBitsy M4"""
# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
"""Uncomment below for an externally defined RGB LED (including Arduino Nano Connect)"""
# import adafruit_rgbled
# from adafruit_esp32spi import PWMOut
# RED_LED = PWMOut.PWMOut(esp, 26)
# GREEN_LED = PWMOut.PWMOut(esp, 27)
# BLUE_LED = PWMOut.PWMOut(esp, 25)
# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)

wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)

counter = 0

while True:
    try:
        print("Posting data...", end="")
        data = counter
        feed = "test"
        payload = {"value": data}
        response = wifi.post(
            "https://io.adafruit.com/api/v2/"
            + secrets["aio_username"]
            + "/feeds/"
            + feed
            + "/data",
            json=payload,
            headers={"X-AIO-KEY": secrets["aio_key"]},
        )
        print(response.json())
        response.close()
        counter = counter + 1
        print("OK")
    except OSError as e:
        print("Failed to get data, retrying\n", e)
        wifi.reset()
        continue
    response = None
    time.sleep(15)
View on GitHub

You'll note here we use a secrets.py file to manage our SSID info. The wifimanager is given the ESP32 object, secrets and a neopixel for status indication.

Note, you'll need to add a some additional information to your secrets file so that the code can query the Adafruit IO API:

  • aio_username
  • aio_key

You can go to your adafruit.io View AIO Key link to get those two values and add them to the secrets file, which will now look something like this:

Download File
Copy Code 
# This file is where you keep secret settings, passwords, and tokens!
# If you put them in the code you risk committing that info or sharing it

secrets = {
    'ssid' : '_your_ssid_',
    'password' : '_your_wifi_password_',
    'timezone' : "America/Los_Angeles", # http://worldtimeapi.org/timezones
    'aio_username' : '_your_aio_username_',
    'aio_key' : '_your_aio_key_',
    }

Next, set up an Adafruit IO feed named test

We can then have a simple loop for posting data to Adafruit IO without having to deal with connecting or initializing the hardware!

Take a look at your test feed on Adafruit.io and you'll see the value increase each time the CircuitPython board posts data to it!

circuitpython_feedstest.jpg

For more information on the basics of doing networking in CircuitPython, see this guide:

Text editor powered by tinymce.

Once you've finished setting up your PyPortal with CircuitPython and have connected to the internet, you can access the code and necessary libraries by downloading the Project Bundle.

To do this, click the Download Project Bundle button in the window below. It will download to your computer as a zipped folder.

Download Project Bundle
Copy Code 
# SPDX-FileCopyrightText: 2024 Brent Rubell, written for Adafruit Industries
#
# SPDX-License-Identifier: MIT
import time
import board
import displayio
import terminalio
from adafruit_display_shapes.rect import Rect
from adafruit_display_text import label
from adafruit_pyportal import PyPortal

# Adafruit IO shared feed key
IO_FEED_KEY = 'location'
# Fetch the location every 5 minutes
SLEEP_DELAY_MINUTES = 5
# Set the backlight brightness, 0.0 (off) to 1.0 (max brightness)
BACKLIGHT_BRIGHTNESS = 0.5
# Location text and images
LOCATION_IMAGES = { 'home': 'images/home.bmp', 'work': 'images/office.bmp',
                    'gym': 'images/workout.bmp', 'commute': 'images/subway.bmp' }

# Create the PyPortal object
pyportal = PyPortal(status_neopixel=board.NEOPIXEL)

# Configure the PyPortal's display
display = board.DISPLAY
display.rotation = 0
display.brightness = BACKLIGHT_BRIGHTNESS

# Display label and image coordinates
TEXT_AREA_X = display.width // 6
TEXT_AREA_Y = 20
TEXT_AREA_LOCATION_X = display.width // 3
TEXT_AREA_LOCATION_Y = display.height - 20
IMAGE_SPRITE_X = (display.width // 3) - 10
IMAGE_SPRITE_Y = display.height // 5

# Create a displayIO Group
group = displayio.Group()

# Draw the background
bg_group = displayio.Group()
rect = Rect(0, 0, display.width, display.height, fill=0xFFFFFF)
bg_group.append(rect)
group.append(bg_group)

# Use the default font
font = terminalio.FONT

# Draw a label for the header text
text_area = label.Label(font, text="Where's My Friend?", color=0x000000, scale=2)
text_area.x = TEXT_AREA_X
text_area.y = TEXT_AREA_Y
group.append(text_area)

# Draw a label for the location text
text_area_location = label.Label(font, text="", color=0x000000, scale=3)
text_area_location.x = TEXT_AREA_LOCATION_X
text_area_location.y = TEXT_AREA_LOCATION_Y
group.append(text_area_location)

# Create a group for the icon only
icon_group = displayio.Group()
group.append(icon_group)

# Show the group
display.root_group = group

def set_image(image_group, filename):
    """Sets the image file for a given group for display."""
    print(f"Set image to {filename}")
    if image_group:
        image_group.pop()

    image_file = open(filename, "rb")
    image = displayio.OnDiskBitmap(image_file)
    image_sprite = displayio.TileGrid(image,
                                      pixel_shader=getattr(image, 'pixel_shader',
                                      displayio.ColorConverter()))
    image_sprite.x = IMAGE_SPRITE_X
    image_sprite.y = IMAGE_SPRITE_Y
    image_group.append(image_sprite)

prv_location = None
while True:
    try:
        print("Fetching location data...")
        # Fetch the location data from Adafruit IO
        feed = pyportal.get_io_feed(IO_FEED_KEY)
        # If the location value is in the list of images
        if feed['last_value'] in LOCATION_IMAGES:
            # Check if the location has changed from the last time
            # we fetched the location
            if prv_location == feed['last_value']:
                print("Location has not changed!")
            else: # Location has changed
                print(f"Location: {feed['last_value']}")
                # Load the image for the current location
                set_image(icon_group, LOCATION_IMAGES[feed['last_value']])
                # Update the location text
                text_area_location.text=f"@ {feed['last_value']}"
                # Show the refreshed group
                display.root_group = group
                # Update the previous location
                prv_location = feed['last_value']
        else:
            print("Location not found in images!")
            # Update the location text
            text_area_location.text="@ unknown"
            # Show the refreshed group
            display.root_group = group
    except RuntimeError as e:
        print("Failed to fetch location data: ", e)

    # Wait 5 minutes (300 seconds) before fetching the location feed again
    print("Sleeping, fetching the location again in 5 minutes!")
    time.sleep(SLEEP_DELAY_MINUTES * 60)
View on GitHub

Upload the Code and Libraries to the PyPortal

After downloading the Project Bundle, plug your PyPortal into the computer's USB port with a known good USB data + power cable. You should see a new flash drive appear in the computer's File Explorer or Finder (depending on your operating system) called CIRCUITPY. Unzip the folder and copy the following items to the CIRCUITPY drive.

  • lib folder
  • images folder
  • code.py

The CIRCUITPY drive should look like this after copying the lib folder, images folder, and the code.py file.

adafruit_products_drive_contents.png

How the CircuitPython Code Works

At the top of the code, we import libraries used for this project and declare variables which you can use to customize your project:

  • IO_FEED_KEY is the shared feed's name.
  • SLEEP_DELAY_SECONDS is how often the code should fetch the location from the Adafruit IO feed, in seconds.
  • BACKLIGHT_BRIGHTNESS configures the TFT backlight's brightness.
  • LOCATION_IMAGES adds text and images for the location feed's values (more on this later!)
Download File
Copy Code 
import time
import board
import displayio
import terminalio
import adafruit_imageload
from adafruit_display_shapes.rect import Rect
from adafruit_display_text import label
from adafruit_pyportal import PyPortal

# Adafruit IO shared feed key
IO_FEED_KEY = 'location'
# Fetch the location every 10 seconds
SLEEP_DELAY_SECONDS = 10
# Set the backlight brightness, 0.0 (off) to 1.0 (max brightness)
BACKLIGHT_BRIGHTNESS = 0.5
# Location text and images
LOCATION_IMAGES = { 'home': 'images/home.bmp', 'work': 'images/office.bmp', 'gym': 'images/workout.bmp', 'commute': 'images/subway.bmp' }

Next, the PyPortal object is created along with the white background, labels for the header and location text, and a group for the icon.

Download File
Copy Code 
# Create the PyPortal object
pyportal = PyPortal(status_neopixel=board.NEOPIXEL)

# Configure the PyPortal's display
display = board.DISPLAY
display.rotation = 0
display.brightness = BACKLIGHT_BRIGHTNESS

# Calculate the text area and image sprite locations based on the PyPortal model
if IS_PYPORTAL_TITANO:
    TEXT_AREA_X = display.width // 5
    TEXT_AREA_Y = 25
    TEXT_AREA_LOCATION_X = (display.width // 3) - 2
    TEXT_AREA_LOCATION_Y = display.height - 25
    IMAGE_SPRITE_X = display.width // 3
    IMAGE_SPRITE_Y = display.height // 4
else: 
    TEXT_AREA_X = display.width // 5
    TEXT_AREA_Y = 25
    TEXT_AREA_LOCATION_X = (display.width // 3) - 2
    TEXT_AREA_LOCATION_Y = display.height - 25
    IMAGE_SPRITE_X = display.width // 3
    IMAGE_SPRITE_Y = display.height // 4

# Create a displayIO Group 
group = displayio.Group()

# Draw the background
bg_group = displayio.Group()
rect = Rect(0, 0, display.width, display.height, fill=0xFFFFFF)
bg_group.append(rect)
group.append(bg_group)

# Use the default font
font = terminalio.FONT

# Draw a label for the header text
text_area = label.Label(font, text="Where is My Friend?", color=0x000000, scale=2)
text_area.x = TEXT_AREA_X
text_area.y = TEXT_AREA_Y
group.append(text_area)

# Draw a label for the location text
text_area_location = label.Label(font, text="@ the park", color=0x000000, scale=3)
text_area_location.x = TEXT_AREA_LOCATION_X
text_area_location.y = TEXT_AREA_LOCATION_Y
group.append(text_area_location)

# Create a group for the icon only
icon_group = displayio.Group()
group.append(icon_group)

# Show the group
display.root_group = group

The set_image() method is from Richard Albritton's Making a PyPortal User Interface with DisplayIO guide. This method simplifies the process of switching between images from within the while True loop.

Download File
Copy Code 
def set_image(group, filename):
    """Sets the image file for a given group for display."""
    print(f"Set image to {filename}")
    if group:
        group.pop()

    if not filename:
        return  # we're done, no icon desired
    try:
        if image_file:
            image_file.close
    except NameError:
        pass
    image_file = open(filename, "rb")
    image = displayio.OnDiskBitmap(image_file)
    image_sprite = displayio.TileGrid(image, pixel_shader=getattr(image, 'pixel_shader', displayio.ColorConverter()))
    image_sprite.x = IMAGE_SPRITE_X
    image_sprite.y = IMAGE_SPRITE_Y
    group.append(image_sprite)

Within the while True loop, we first fetch the Adafruit IO feed's most recent value.

Download File
Copy Code 
print("Fetching location data...")
# Fetch the location data from Adafruit IO
feed = pyportal.get_io_feed(IO_FEED_KEY)

We check if the feed's value is associated with the list of locations, LOCATION_IMAGES and if the feed's value has changed since the last time it was fetched.

Download File
Copy Code 
# If the location value is in the list of images
        if feed['last_value'] in LOCATION_IMAGES:
            # Check if the location has changed from the last time
            # we fetched the location
            if prv_location == feed['last_value']:
                print("Location has not changed!")

If the value of the location feed has changed, we print out the location feed. Then, we use the set_image() method to load the desired icon onto the screen.

Download File
Copy Code 
else: # Location has changed
  print(f"Location: {feed['last_value']}")
  # Load the image for the current location
  set_image(icon_group, LOCATION_IMAGES[feed['last_value']])

Within LOCATION_IMAGES there is a dictionary of locations and associated images (in bitmap (bmp) format).

If you want to display different locations from the pre-selected ones - Change the dictionary's values and the image's file path.

Download File
Copy Code 
LOCATION_IMAGES = { 'home': 'images/home.bmp', 'work': 'images/office.bmp', 'gym': 'images/workout.bmp', 'commute': 'images/subway.bmp' }

The text on the bottom of the screen is updated to display "@ [CURRENT LOCATION]" and the display is forced to refresh. Finally, we update the prv_location variable to store the current feed value.

Download File
Copy Code 
# Update the location text
text_area_location.text=f"@ {feed['last_value']}"
# Show the refreshed group
display.root_group = group
# Update the previous location
prv_location = feed['last_value']

At the end of the while True loop, we wait 5 minutes before attempting to fetch the location feed again.

Download File
Copy Code 
# Wait 5 minutes (300 seconds) before fetching the location feed again
print("Sleeping, fetching the location again in 5 minutes!")
time.sleep(SLEEP_DELAY_SECONDS)

Text editor powered by tinymce.

Viewing the location on PyPortal

Plug the PyPortal into USB power. You should see the display change, reflecting the current value of the location feed.

If no value has been written to this feed yet, your PyPortal's screen will display "@ Unknown".

adafruit_products_IMG_1440.jpg

When your friend moves within the range of a pre-set location, the Automation will write the location's name to the shared Adafruit IO feed.

adafruit_products_commute-loc.png

Every five minutes, the PyPortal's display will update with the current location. If their location hasn't changed, the display will display the last known location.

adafruit_products_BEE9B909-86F5-4C23-A449-240118CC450A_1_201_a.jpeg

Text editor powered by tinymce.

Related Guides
Adafruit PyPortal - IoT for CircuitPython
By Kattni Rembor
167
Beginner
Updated
Adafruit PyPortal Titano
By Kattni Rembor
39
Beginner
Updated
Making a PyPortal User Interface with DisplayIO
By Richard Albritton
76
Intermediate
PyPortal Winamp MP3 Player
By Tim C
48
Beginner
Updated
Creating Slideshows in CircuitPython
By Anne Barela
15
Beginner
IoT Power Outlet with CircuitPython and Adafruit IO
By Brent Rubell
16
Beginner
PyPortal Quarantine Clock
By Brent Rubell
15
Beginner
PyPortal Cutefuzz Image Viewer
By John Park
6
Beginner
Program CircuitPython USB Devices with iPhone & iPad
By Collin Cunningham
42
Beginner
Electronic History of the Day with PyPortal
By Isaac Wellish
10
Beginner
PyPortal Google Calendar Event Display
By Brent Rubell
32
Intermediate
PyPortal Retro Cases
By Ruiz Brothers
44
Beginner
Quick Start: Pico W with WipperSnapper
By Brent Rubell
19
Beginner
Portable PyPortal
By Ruiz Brothers
17
Beginner
Using LittlevGL with Adafruit Displays
By Phillip Burgess
19
Beginner
Scan QR Codes with CircuitPython
By Jeff Epler
9
Beginner
Search

Search

Categories