Magtag Covid Tracking Project Iot Display: Created by Lady Ada
Magtag Covid Tracking Project Iot Display: Created by Lady Ada
Magtag Covid Tracking Project Iot Display: Created by Lady Ada
Guide Contents 2
Overview 3
Parts Required 3
Also needed: 4
Install CircuitPython 5
Set Up CircuitPython 5
Option 1 - Load with UF2 Bootloader 6
Try Launching UF2 Bootloader 6
Option 2 - Use esptool to load BIN file 7
Option 3 - Use Chrome Browser To Upload BIN file 8
CircuitPython Internet Libraries 9
Adafruit CircuitPython Library Bundle 9
CircuitPython Internet Test 10
Secrets File 10
Connect to WiFi 11
Getting The Date & Time 16
Step 1) Make an Adafruit account 16
Step 2) Sign into Adafruit IO 16
Step 3) Get your Adafruit IO Key 16
Step 4) Upload Test Python Code 17
MagTag-Specific CircuitPython Libraries 20
Get Latest Adafruit CircuitPython Bundle 20
Secrets 20
Project Code 22
Download and Install Code + Font 22
Code Walkthrough 24
Daily Update Time 25
Text Transforms with lambdas 25
Adding a QR Code 26
Connect and Update 26
Custom Plastic Cutout 29
The Covid Tracking Project (https://covidtracking.com (https://adafru.it/Pdd)) tracks all US state data and
collates it into one report. This project for MagTag wakes up once a day at 8pm, about a half hour after the
data is posted daily, and displays the latest data report.
In between check-ins the MagTag goes into a deep sleep mode so it will run for many weeks on a charge
Parts Required
You'll want a MagTag + battery, and magnetic feet to attach it to your fridge or other metallic surface
Also needed:
Set Up CircuitPython
Follow the steps to get CircuitPython installed on your MagTag.
https://adafru.it/OBd
https://adafru.it/OBd
Click the link above and download the latest .BIN and
.UF2 file
Copy the UF2 file you downloaded at the first step of this
tutorial onto the MAGTAGBOOT drive
If you're using Windows and you get an error at the end of the file copy that says Error from the file copy,
Error 0x800701B1: A device which does not exist was specified. You can ignore this error, the bootloader
sometimes disconnects without telling Windows, the install completed just fine and you can continue. If its
really annoying, you can also upgrade the bootloader (the latest version of the UF2 bootloader fixes this
warning) (https://adafru.it/Pfk)
You can upload with esptool to the ROM (hardware) bootloader instead!
Follow the initial steps found in the Run esptool and check
connection section of the ROM Bootloader
page (https://adafru.it/OBc) to verify your environment is
set up, your board is successfully connected, and which
port it's using.
https://adafru.it/ENC
https://adafru.it/ENC
Download the adafruit-circuitpython-bundle-version-mpy-*.zip bundle zip file, and unzip a folder of the
same name. Inside you'll find a lib folder. The entire collection of libraries is too large to fit on
the CIRCUITPY drive. Instead, 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!
Once you have added those files, please continue to the next page to set up and test Internet connectivity
Secrets File
We expect people to share tons of projects as they build CircuitPython WiFi widgets. What we want to
avoid is people accidentally sharing their passwords or secret tokens and API keys. So, we designed all
our examples to use a secrets.py file, that is in your CIRCUITPY drive, to hold secret/private/custom data.
That way you can share your main project without worrying about accidentally sharing private stuff.
# 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' : 'home_wifi_network',
'password' : 'wifi_password',
'aio_username' : 'my_adafruit_io_username',
'aio_key' : 'my_adafruit_io_key',
'timezone' : "America/New_York", # http://worldtimeapi.org/timezones
}
Copy and paste that text/code into a file called secrets.py and save it to your CIRCUITPY folder like so:
Inside is a python dictionary named secrets with a line for each entry. Each entry has an entry name
At a minimum you'll need to adjust the ssid and password for your local WiFi setup so do that now!
As you make projects you may need more tokens and keys, just add them one line at a time. See for
example other tokens such as one for accessing github or the hackaday API. Other non-secret data like
your timezone can also go here, just cause its called secrets doesn't mean you can't have general
customization data in there!
For the correct time zone string, look at http://worldtimeapi.org/timezones (https://adafru.it/EcP) and
remember that if your city is not listed, look for a city in the same time zone, for example Boston, New
York, Philadelphia, Washington DC, and Miami are all on the same time as New York.
Of course, don't share your secrets.py - keep that out of GitHub, Discord or other project-sharing sites.
Don't share your secrets.py file, it has your passwords and API keys in it!
Connect to WiFi
OK now you have your secrets setup - you can connect to the Internet using the Requests module.
First make sure you are running the latest version of Adafruit CircuitPython (https://adafru.it/Amd) for your
board.
Next you'll need to install the necessary libraries to use the hardware--carefully follow the steps to find and
install these libraries from Adafruit's CircuitPython library bundle (https://adafru.it/zdx). Our introduction
guide has a great page on how to install the library bundle (https://adafru.it/ABU).
adafruit_requests
neopixel
Before continuing make sure your board's CIRCUITPY/lib folder or root filesystem has the above files
copied over.
Once that's done, load up the following example using Mu or your favorite editor:
print("Connecting to %s"%secrets["ssid"])
wifi.radio.connect(secrets["ssid"], secrets["password"])
print("Connected to %s!"%secrets["ssid"])
print("My IP address is", wifi.radio.ipv4_address)
ipv4 = ipaddress.ip_address("8.8.4.4")
print("Ping google.com: %f ms" % (wifi.radio.ping(ipv4)*1000))
pool = socketpool.SocketPool(wifi.radio)
requests = adafruit_requests.Session(pool, ssl.create_default_context())
print()
print("done")
And save it to your board. Make sure the file is named code.py.
Open up your REPL, you should see something like the following:
Performs a scan of all access points and prints out the access point's name (SSID), signal strength (RSSI),
and channel.
Connects to the access point you defined in the secrets.py file, prints out its local IP address, and attempts
to ping google.com to check its network connectivity.
print("Connecting to %s"%secrets["ssid"])
wifi.radio.connect(secrets["ssid"], secrets["password"])
print(print("Connected to %s!"%secrets["ssid"]))
print("My IP address is", wifi.radio.ipv4_address)
ipv4 = ipaddress.ip_address("8.8.4.4")
print("Ping google.com: %f ms" % wifi.radio.ping(ipv4))
The code creates a socketpool using the wifi radio's available sockets. This is performed so we don't need
to re-use sockets. Then, it initializes a a new instance of the requests (https://adafru.it/E9o) interface -
which makes getting data from the internet really really easy.
pool = socketpool.SocketPool(wifi.radio)
requests = adafruit_requests.Session(pool, ssl.create_default_context())
To read in plain-text from a web URL, call requests.get - you may pass in either a http, or a http s url for SSL
connectivity.
Requests can also display a JSON-formatted response from a web URL using a call to requests.get .
Finally, you can fetch and parse a JSON URL using requests.get . This code snippet obtains the
stargazers_count field from a call to the GitHub API.
OK you now have your ESP32-S2 board set up with a proper secrets.py file and can connect over the
Internet. If not, check that your secrets.py file has the right ssid and password and retrace your steps until
you get the Internet connectivity working!
Determining the correct local time is really really hard. There are various time zones, Daylight Savings
dates, leap seconds, etc. Trying to get NTP time and then back-calculating what the local time is, is
extraordinarily hard on a microcontroller just isn't worth the effort and it will get out of sync as laws change
anyways.
For that reason, we have the free adafruit.io time service. Free for anyone, with a free adafruit.io account.
You do need an account because we have to keep accidentally mis-programmed-board from
overwhelming adafruit.io and lock them out temporarily. Again, it's free!
There are other services like WorldTimeAPI, but we don't use those for our guides because they
are nice people and we don't want to accidentally overload their site. Also, there's a chance it
may eventually go down or also require an account.
You will get a popup with your Username and Key (In this screenshot, we've covered it with red blocks)
# 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' : 'home_wifi_network',
'password' : 'wifi_password',
'aio_username' : 'my_adafruit_io_username',
'aio_key' : 'my_adafruit_io_key',
'timezone' : "America/New_York", # http://worldtimeapi.org/timezones
}
The timezone is optional, if you don't have that entry, adafruit.io will guess your timezone based on
geographic IP address lookup. You can visit http://worldtimeapi.org/timezones (https://adafru.it/EcP) to see
all the time zones available (even though we do not use worldtimeapi for time-keeping we do use the
same time zone table)
TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
JSON_QUOTES_URL = "https://www.adafruit.com/api/quotes.php"
JSON_STARS_URL = "https://api.github.com/repos/adafruit/circuitpython"
print("Connecting to %s"%secrets["ssid"])
wifi.radio.connect(secrets["ssid"], secrets["password"])
print("Connected to %s!"%secrets["ssid"])
print("My IP address is", wifi.radio.ipv4_address)
ipv4 = ipaddress.ip_address("8.8.4.4")
print("Ping google.com: %f ms" % wifi.radio.ping(ipv4))
pool = socketpool.SocketPool(wifi.radio)
requests = adafruit_requests.Session(pool, ssl.create_default_context())
After running this, you will see something like the below text. We have blocked out the part with the secret
Note at the end you will get the date, time, and your timezone! If so, you have correctly configured your
secrets.py and can continue to the next steps!
https://adafru.it/ENC
https://adafru.it/ENC
Download the adafruit-circuitpython-bundle-version-mpy-*.zip bundle zip file, and unzip a folder of the
same name. Inside you'll find a lib folder. The entire collection of libraries is too large to fit on the
CIRCUITPY drive. Therefore, you'll need to copy the necessary libraries to your board individually.
At a minimum, the following libraries are required. Copy the following folders or .mpy files to the lib folder
on your CIRCUITPY drive. If the library is a folder, copy the entire folder to the lib folder on your board.
adafruit_magtag - This is a helper library designed for using all of the features of the MagTag,
including networking, buttons, NeoPixels, etc.
adafruit_portalbase - This library is the base library that adafruit_magtag is built on top of.
adafruit_bitmap_font - There is fancy font support, and it's easy to make new fonts. This library reads
and parses font files.
adafruit_display_text - This library displays text on the screen.
adafruit_io - This library helps connect the MagTag to our free data logging and viewing service
Library files:
adafruit_requests.mpy - This library allows us to perform HTTP requests and get responses back
from servers. GET/POST/PUT/PATCH - they're all in here!
adafruit_fakerequests.mpy - This library allows you to create fake HTTP requests by using local files.
adafruit_miniqr.mpy - QR creation library lets us add easy-to-scan 2D barcodes to the E-Ink display
neopixel.mpy - This library is used to control the onboard NeoPixels.
simpleio.mpy - This library is used for tone generation.
Secrets
Even if you aren't planning to go online with your MagTag, you'll need to have a secrets.py file in the root
Once ready, click the Download: Project Zip File link below in the code window to get a zip file with all the
files needed for the project. Copy code.py from the zip file and place on the CIRCUITPY drive along with
the fonts/ directory that contains the arial-bold-12.pcf font
# Change this to the hour you want to check the data at, for us its 8pm
# local time (eastern), which is 20:00 hrs
DAILY_UPDATE_HOUR = 20
magtag = MagTag(
url=DATA_SOURCE,
json_path=(DATE_LOCATION, NEWPOS_LOCATION,
CURRHOSP_LOCATION, NEWHOSP_LOCATION,
ALLDEATH_LOCATION, NEWDEATH_LOCATION),
)
# updated time
magtag.add_text(
text_font="/fonts/Arial-Bold-12.pcf",
text_position=(245, 30),
line_spacing=0.75,
is_data=False
)
magtag.graphics.qrcode(b"https://covidtracking.com/data",
qr_size=2, x=240, y=70)
magtag.peripherals.neopixels.brightness = 0.1
magtag.peripherals.neopixel_disable = False # turn on lights
magtag.peripherals.neopixels.fill(0x0F0000) # red!
magtag.get_local_time()
try:
now = time.localtime()
print("Now: ", now)
# OK we're done!
magtag.peripherals.neopixels.fill(0x000F00) # greten
except (ValueError, RuntimeError) as e:
# we only wanna wake up once a day, around the event update time:
event_time = time.struct_time((now[0], now[1], now[2],
DAILY_UPDATE_HOUR, 0, 0,
-1, -1, now[8]))
# how long is that from now?
remaining = time.mktime(event_time) - time.mktime(now)
if remaining < 0: # ah its aready happened today...
remaining += 24 * 60 * 60 # wrap around to the next day
remaining_hrs = remaining // 3660
remaining_min = (remaining % 3600) // 60
print("Gonna zzz for %d hours, %d minutes" % (remaining_hrs, remaining_min))
# Turn it all off and go to bed till the next update time
magtag.exit_and_deep_sleep(remaining)
Code Walkthrough
Thankfully, the Covid Tracking Project folks made a free, easy-to-use JSON API endpoint that you can
easily query with the MagTag to get the current stats at https://api.covidtracking.com/v1/us/current.json
You can click on it right from your browser to see the current data and you'll get something like this
These are pretty self-explanatory, note that date is not the current date, but the date at which the data
was collected. We'll be displaying positiveIncrease , hospitalizedCurrently, hospitalizedIncrease, death and
deathIncrease but of course the display can be customized.
# Change this to the hour you want to check the data at, for us its 8pm
# local time (eastern), which is 20:00 hrs
DAILY_UPDATE_HOUR = 20
To do that we use an 'anonymous function' (a.k.a. a lambda) which we can code in-line that will take the
string extracted " 1339749 " and preface it with the text " New positive: " as well as putting commas in
between the digit groupings.
def anonymous_function(x):
return "New positive: {:,}".format(x)
Adding a QR Code
For more info, you can visit the CTP website, we insert a QR code which will show on the E-Ink display
very nicely and can be scanned to get the full report
The ' qr_size ' indicates the scaling, e.g. how big the pixel squares are. X and Y coordinates puts it over
on the bottom right
magtag.get_local_time()
try:
now = time.localtime()
print("Now: ", now)
# OK we're done!
magtag.peripherals.neopixels.fill(0x000F00) # greten
except (ValueError, RuntimeError) as e:
print("Some error occured, trying again later -", e)
After the display has updated, its time to go to sleep. For this project we want to wake up at exactly 8pm,
which might be later today or it might be tomorrow. Since we don't know what day it will be, we first
assume that we will be waking up later today by creating a new time structure with the same year, month,
day as today but the hour, min, sec is DAILY_UPDATE_HOUR, 0, 0:
Then we convert the current time, and the next-wakeup time to seconds using time.mktime() and subtract
the difference. That is, what is the number of seconds between these two time points
If the amount of time is negative, that mean's that the "wake up today" time already happened, so we add
24-hours-worth of seconds to the time difference, to get to the event time one day later (tomorrow!)
We then display that time in hours and minutes, just for us to debug as humans
And finally, we go into deep sleep mode until that time comes up
If you'd like to give your MagTag a custom plastic cutout, you can cut out this AI file on a laser cutter or
CNC cutter out of 1.5mm thick material
https://adafru.it/Pde
https://adafru.it/Pde