# Electronic History of the Day with PyPortal ## Overview ![](https://cdn-learn.adafruit.com/assets/assets/000/087/872/medium800/lcds___displays_mouse_cover_2.jpg?1580419427) This PyPortal project shows one notable electronic or science fact every day. Based on what day it is, CircuitPython code grabs JSON data from a database and then prints information about the person associated with that day. Want more info on the person? Use the QR code! [We created our very own database with data on the most memorable electronics and sciencey peoples](https://github.com/adafruit/OTD/tree/master/electronics). The CircuitPython code grabs from this database to bring you all these great factoids! ![](https://cdn-learn.adafruit.com/assets/assets/000/087/873/medium800/lcds___displays_plain_cover_2.jpg?1580419578) ## Parts You can pick up an Adafruit PyPortal and a USB cable (if needed). If you like, you can mount the PyPortal in the Adafruit laser-cut acrylic stand. ### 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) ### USB cable - USB A to Micro-B [USB cable - USB A to Micro-B](https://www.adafruit.com/product/592) This here is your standard A to micro-B USB cable, for USB 1.1 or 2.0. Perfect for connecting a PC to your Metro, Feather, Raspberry Pi or other dev-board or microcontroller Approximately 3 feet / 1 meter long Out of Stock [Buy Now](https://www.adafruit.com/product/592) [Related Guides to the Product](https://learn.adafruit.com/products/592/guides) ![USB cable - USB A to Micro-B - 3 foot long](https://cdn-shop.adafruit.com/640x480/592-01.jpg) ### Adafruit PyPortal Desktop Stand Enclosure Kit [Adafruit PyPortal Desktop Stand Enclosure Kit](https://www.adafruit.com/product/4146) 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 universes of joy that connect to something good. And now that you've made a cool internet-connected project... In Stock [Buy Now](https://www.adafruit.com/product/4146) [Related Guides to the Product](https://learn.adafruit.com/products/4146/guides) ![Demo Shot of the Assembled Adafruit PyPortal Desktop Stand Enclosure Kit.](https://cdn-shop.adafruit.com/640x480/4146-03.jpg) You can use any case you like. If you get the stand enclosure kit, the instructions for assembly are in [this guide page](https://learn.adafruit.com/adafruit-pyportal/build-the-pyportal-stand). You can see some other cases (3D printed, etc. via [this Adafruit Learning System link](https://learn.adafruit.com/search?q=pyportal%20case). # Electronic History of the Day with PyPortal ## 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) # Electronic History of the Day with PyPortal ## 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. # Electronic History of the Day with PyPortal ## 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. # Electronic History of the Day with PyPortal ## Download Project Files from GitHub All of the files required for this project (the code, graphics, and font) are available for download on GitHub. There are  **two code files**  for this project, our regular  **code.py**  along with  **secrets.py** You'll need to edit  **secrets.py**  with your applicable information. You can find more info on all of the code files in the next two pages of this guide. ## 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\_on\_this\_day**. Copy the contents of the  **PyPortal\_on\_this\_day** directory to your PyPortal **CIRCUITPY**  drive. ![](https://cdn-learn.adafruit.com/assets/assets/000/087/772/medium800/lcds___displays_replace1.png?1580252735) https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_on_this_day/code.py ## Used libraries This project uses the following CircuitPython libraries loaded in the Project Bundle: - **adafruit\_bitmap\_font**  (directory) - **adafruit\_bus\_device**  (directory) - **adafruit\_display\_shapes**  (directory) - **adafruit\_display\_text**  (directory) - **adafruit\_esp32spi**  (directory) - **adafruit\_io**  (directory) - **adafruit\_miniqr.mpy** (file) - **adafruit\_pyportal.mpy**  (file) - **adafruit\_requests**  (file) - **adafruit\_touchscreen.mpy**  (file) - **neopixel.mpy**  (file) This is what the final contents of the  **CIRCUITPY**  drive will look like: ![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/PyPortal_PyPortal_on_this_day.png ) ## Double check See the directory listing above and double check that you have all the files listed to make this project function. If any are missing or in an incorrect directory, move them so they're in the right places. The project will not work correctly unless the files are in the right locations. # Electronic History of the Day with PyPortal ## Code Walkthrough - code.py **code.py** is the file where the main code of the program resides! ### Background First, the program displays a bitmap graphic as the screen's background. This background has the title of the program as well as a couple of sub-titles to make the data more readable. This is a 320 x 240 pixel RGB 16-bit raster graphic in **.bmp**  format. If you would like to create your own background, awesome! You'll want to save the file with these specifications: - 320 x 240 pixels - 16-bit RGB color - Save file as .bmp format You can then copy the .bmp file to the root level of the  **CIRCUITPY**  drive. Make sure you refer to this new filename in the pyportal constructor line: `default_bg=cwd+ "/on_this_day_bg.bmp"` Change that line to use the new filename name, such as: `default_bg=cwd+"/my_new_background.bmp"` ![](https://cdn-learn.adafruit.com/assets/assets/000/087/815/medium800/lcds___displays_image.png?1580334009) ### Font The fonts used here are bitmap fonts made from the Arial Italic typeface. You can learn more about [converting type in this guide](https://learn.adafruit.com/custom-fonts-for-pyportal-circuitpython-display). ### JSON The neat part is that the text is not coming from a file on the device, but rather it is taken from a website! ### The OTD Database [The Adafruit "OTD" repository on Github](https://github.com/adafruit/OTD) is where we're storing all this enlightening data. We can grab the JSON directly from Github site and display it on the PyPortal. - [Head to the site here](https://github.com/adafruit/OTD) to see the lovely home of all this data. - Click on the ["electronics" folder](https://github.com/adafruit/OTD/tree/master/electronics). - Now click any of the dates you want to see that data for, and voila there's the data! - Now click on the "raw" button. - This leads to the direct source of the JSON data, where the data is pulled from. ![lcds___displays_Screen_Shot_2020-01-29_at_4.50.43_PM.png](https://cdn-learn.adafruit.com/assets/assets/000/087/818/medium640/lcds___displays_Screen_Shot_2020-01-29_at_4.50.43_PM.png?1580334681) ![lcds___displays_Screen_Shot_2020-01-29_at_4.44.36_PM.png](https://cdn-learn.adafruit.com/assets/assets/000/087/819/medium640/lcds___displays_Screen_Shot_2020-01-29_at_4.44.36_PM.png?1580334724) ![lcds___displays_Screen_Shot_2020-01-29_at_4.57.19_PM.png](https://cdn-learn.adafruit.com/assets/assets/000/087/821/medium640/lcds___displays_Screen_Shot_2020-01-29_at_4.57.19_PM.png?1580335209) ![lcds___displays_Screen_Shot_2020-01-29_at_4.57.31_PM.png](https://cdn-learn.adafruit.com/assets/assets/000/087/822/medium640/lcds___displays_Screen_Shot_2020-01-29_at_4.57.31_PM.png?1580335240) ### How to reference JSON data in code.py The below code is the JSON data for Jan 25. ```python { "Day of the year":"January 25", "Person":"Robert Boyle", "Notable for":"Chemist, Physicist", "Year":"1627", "Accomplishment":"Chemistry, pV=Nrt", "Web Reference":"wikipedia.org/wiki/Robert_Boyle" } ``` If we look through the JSON file, we'll see 6 **keys** called `Day of the year`, `Person`, `Notable for` etc. Each **key** has an associated **value** paired with it. Our CircuitPython code is able to grab and parse this data using these variables: ```python DAY = ["Day of the year"] PERSON = ["Person"] NOTABLE = ["Notable for"] YEAR = ["Year"] ACCOMPLISH = ["Accomplishment"] WEB = ["Web Reference"] ``` Next, here's our data source from above! ```python BASE_DATA = "https://raw.githubusercontent.com/adafruit/OTD/master/electronics/" ``` ## PyPortal Constructor Then, in the `pyportal` query we ask for the `Day of the year`, `Person`, `Notable for` etc. from that URL, and then use the `text_` arguments to set the `font`, `transform`, `position`, `color`, and `maxlen` of the text when it is displayed. ```python pyportal = PyPortal(url = BASE_DATA, debug=True, json_path = (DAY, PERSON, NOTABLE, YEAR, ACCOMPLISH, WEB), status_neopixel = board.NEOPIXEL, default_bg = cwd + "/on_this_day_bg.bmp", text_font = cwd+"fonts/Arial-ItalicMT-17.bdf", text_transform = [identity]*6, # we do this so the date doesnt get commas text_position=((10, 70), (10, 100), (10, 130),(60, 160), (105, 190), (10, 220)), text_color=(0xFFFFFF, 0xFFFFFF, 0xFFFFFF, 0xFFFFFF, 0xFFFFFF, 0xFFFFFF), text_maxlen=(50, 50, 50, 50, 50, 50), # cut off characters ) ``` With all of this prepared, during the main loop of `while True:` the code will: - Find out what day it is and insert that date at the end of the data URL. - With that new URL, the porgram will query the Adafruit OTD Github page for the JSON data, and display it, along with the QR code for the associated Wikipedia link. - Then the program will wait 10 minutes until repeating the process. And that's the whole program! ## 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) ### Adafruit PyPortal Desktop Stand Enclosure Kit [Adafruit PyPortal Desktop Stand Enclosure Kit](https://www.adafruit.com/product/4146) 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 universes of joy that connect to something good. And now that you've made a cool internet-connected project... In Stock [Buy Now](https://www.adafruit.com/product/4146) [Related Guides to the Product](https://learn.adafruit.com/products/4146/guides) ### Adafruit PyPortal Pynt - CircuitPython Powered Internet Display [Adafruit PyPortal Pynt - CircuitPython Powered Internet Display](https://www.adafruit.com/product/4465) The **PyPortal Pynt** is the little sister to our [popular PyPortal](https://www.adafruit.com/product/4116) - zapped with a shrink ray to take the design from a 3.2" diagonal down to 2.4" diagonal screen - but otherwise the same! The PyPortal is our... No Longer Stocked [Buy Now](https://www.adafruit.com/product/4465) [Related Guides to the Product](https://learn.adafruit.com/products/4465/guides) ### Adafruit PyPortal Titano [Adafruit PyPortal Titano](https://www.adafruit.com/product/4444) The **PyPortal Titano** is the big sister to our [popular PyPortal](https://www.adafruit.com/product/4116) now with _twice as many pixels!_ The PyPortal is our easy-to-use IoT device that allows you to create all the things for the “Internet of... Out of Stock [Buy Now](https://www.adafruit.com/product/4444) [Related Guides to the Product](https://learn.adafruit.com/products/4444/guides) ### USB cable - USB A to Micro-B [USB cable - USB A to Micro-B](https://www.adafruit.com/product/592) This here is your standard A to micro-B USB cable, for USB 1.1 or 2.0. Perfect for connecting a PC to your Metro, Feather, Raspberry Pi or other dev-board or microcontroller Approximately 3 feet / 1 meter long Out of Stock [Buy Now](https://www.adafruit.com/product/592) [Related Guides to the Product](https://learn.adafruit.com/products/592/guides) ## Related Guides - [Adafruit PyPortal - IoT for CircuitPython](https://learn.adafruit.com/adafruit-pyportal.md) - [Adafruit PyPortal Titano](https://learn.adafruit.com/adafruit-pyportal-titano.md) - [PyPortal Weather Station](https://learn.adafruit.com/pyportal-weather-station.md) - [CircuitPython Neko Kitty with Displayio](https://learn.adafruit.com/circuitpython-neko-kitty-with-displayio.md) - [PyPortal Winamp MP3 Player](https://learn.adafruit.com/pyportal-winamp-mp3-player.md) - [TFT Spirit Board](https://learn.adafruit.com/tft-spirit-board.md) - [PyPortal New New New Product Viewer](https://learn.adafruit.com/pyportal-new-new-new-product-viewer.md) - [Smart Mirror with PyPortal](https://learn.adafruit.com/smart-mirror-with-pyportal.md) - [PyPortal Event Count-Up Clock](https://learn.adafruit.com/pyportal-event-count-up-clock.md) - [PyPortal MQTT Sensor Node/Control Pad for Home Assistant](https://learn.adafruit.com/pyportal-mqtt-sensor-node-control-pad-home-assistant.md) - [PyPortal LIFX Lighting Controller ](https://learn.adafruit.com/pyportal-lifx-lighting-controller.md) - [MQTT in CircuitPython](https://learn.adafruit.com/mqtt-in-circuitpython.md) - [Cleveland Museum of Art PyPortal Frame](https://learn.adafruit.com/cleveland-museum-of-art-pyportal-frame.md) - [PyPortal US Election Calendar](https://learn.adafruit.com/pyportal-electioncal-us.md) - [Glider Paper Airplane Controller](https://learn.adafruit.com/glider-paper-airplane-controller.md) - [ESP-NOW Walkie Talkies](https://learn.adafruit.com/esp-now-walkie-talkies.md)