# PyPortal Google Calendar Event Display

## Overview

Danger: This project's code uses the CircuitPython OAuth Library for authentication with Google services. Due to Google's update to the OAuth "authentication flow", the library became incompatible. As a result, this project does not currently work (but may in the future).

![](https://cdn-learn.adafruit.com/assets/assets/000/098/615/medium800/circuitpython_IMG_9192.jpg?1610551542)

 **Keep an eye on your schedule with this PyPortal Google Calendar Event Viewer.** &nbsp;This CircuitPython project uses the&nbsp;[Google Calendar API](https://developers.google.com/calendar/)&nbsp;to retrieve a list of the latest events from your Google Calendar and displays them on the PyPortal's screen.

This guide is almost identical to the [MagTag Google Calendar Event Display Guide](https://learn.adafruit.com/google-calendar-event-display/), except it doesn't have a deep-sleep mode.

## Parts
### 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&nbsp;tinyJSON / APIs to get news, stock, weather, cat photos,...

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

### Adafruit PyPortal Desktop Stand Enclosure Kit

[Adafruit PyPortal Desktop Stand Enclosure Kit](https://www.adafruit.com/product/4146)
PyPortal is&nbsp;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)

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

# PyPortal Google Calendar Event Display

## Install CircuitPython

[CircuitPython](https://github.com/adafruit/circuitpython) is a derivative of [MicroPython](https://micropython.org) designed to simplify experimentation and education on low-cost microcontrollers. It makes it easier than ever to get prototyping by requiring no upfront desktop software downloads. Simply copy and edit files on the **CIRCUITPY** &nbsp;"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.&nbsp; **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-\<whatever\>.uf2** file to **PORTALBOOT.**

![circuitpython_PyPortal_PORTALBOOT.png](https://cdn-learn.adafruit.com/assets/assets/000/072/029/medium640/circuitpython_PyPortal_PORTALBOOT.png?1551287972)

![circuitpython_PyPortal_Drag_UF2.png](https://cdn-learn.adafruit.com/assets/assets/000/072/030/medium640/circuitpython_PyPortal_Drag_UF2.png?1551287983)

The LED will flash. Then, the **PORTALBOOT** drive will disappear and a new disk drive called **CIRCUITPY** will appear.

If you haven't added any code to your board, the only file that will be present is **boot\_out.txt**. This is absolutely normal! It's time for you to add your **code.py** and get started!

That's it, you're done! :)

![circuitpython_PyPortalCIRCUITPY.png](https://cdn-learn.adafruit.com/assets/assets/000/071/995/medium640/circuitpython_PyPortalCIRCUITPY.png?1551213875)

## PyPortal Default Files

Click below to download a zip of the files that shipped on the PyPortal or PyPortal Pynt.

[PyPortal Default Files](https://github.com/adafruit/circuitpython-default-files/tree/main/boards/pyportal/4.x)
[PyPortal Pynt Default Files](https://github.com/adafruit/circuitpython-default-files/tree/main/boards/pyportal_pynt/5.x)
# PyPortal Google Calendar Event Display

## PyPortal CircuitPython Setup

To use all the amazing features of your PyPortal with CircuitPython, you must first install a number of libraries. This page covers that process.

# Adafruit CircuitPython Bundle

Download the Adafruit CircuitPython Library Bundle. You can find the latest release here:

[Latest Adafruit CircuitPython Library Bundle](https://circuitpython.org/libraries)
Download the **adafruit-circuitpython-bundle-\*.x-mpy-\*.zip** bundle zip file where **\*.x MATCHES THE VERSION OF CIRCUITPYTHON YOU INSTALLED** , and unzip a folder of the same name. Inside you'll find a **lib** folder. You have two options:

- You can add the **lib** folder to your **CIRCUITPY** drive. This will ensure you have _all the drivers_. But it will take a bunch of space on the 8 MB disk  
- Add each library as you need it, this will reduce the space usage but you'll need to put in a little more effort.

At a minimum we recommend the following libraries, in fact we more than recommend. They're basically required. So grab them and install them into **CIRCUITPY/lib** now!

- **adafruit\_esp32spi** - This is the library that gives you internet access via the ESP32 using (you guessed it!) SPI transport. You need this for anything Internet
- **adafruit\_requests** - This library allows us to perform HTTP requests and get responses back from servers. GET/POST/PUT/PATCH - they're all in here!
- adafruit\_connection\_manager - used by adafruit\_requests.
- **adafruit\_pyportal** - This is our friendly wrapper library that does a lot of our projects, displays graphics and text, fetches data from the internet. Nearly all of our projects depend on it!
- **adafruit\_portalbase** &nbsp;- 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** &nbsp;- This library allows you to create fake HTTP requests by using local files.

# PyPortal Google Calendar Event Display

## Create Your settings.toml File

CircuitPython works with WiFi-capable boards to enable you to make projects that have network connectivity. This means working with various passwords and API keys. As of [CircuitPython 8](https://circuitpython.org/downloads), there is support for a **settings.toml** file. This is a file that is stored on your **CIRCUITPY** drive, that contains all of your secret network information, such as your SSID, SSID password and any API keys for IoT services. It is designed to separate your sensitive information from your **code.py** file so you are able to share your code without sharing your credentials.

CircuitPython previously used a **secrets.py** file for this purpose. The **settings.toml** file is quite similar.

Warning: Your **settings.toml** file should be stored in the main directory of your **CIRCUITPY** drive. It should not be in a folder.

## CircuitPython **settings.toml** File

This section will provide a couple of examples of what your **settings.toml** file should look like, specifically for CircuitPython WiFi projects in general.

The most minimal **settings.toml** file must contain your WiFi SSID and password, as that is the minimum required to connect to WiFi. Copy this example, paste it into your **settings.toml** , and update:

- `your_wifi_ssid`
- `your_wifi_password`

```auto
CIRCUITPY_WIFI_SSID = "your_wifi_ssid"
CIRCUITPY_WIFI_PASSWORD = "your_wifi_password"
```

Many CircuitPython network-connected projects on the Adafruit Learn System involve using Adafruit IO. For these projects, you must _also_ include your Adafruit IO username and key. Copy the following example, paste it into your settings.toml file, and update:

- `your_wifi_ssid`
- `your_wifi_password`
- `your_aio_username`
- `your_aio_key`

```auto
CIRCUITPY_WIFI_SSID = "your_wifi_ssid"
CIRCUITPY_WIFI_PASSWORD = "your_wifi_password"
ADAFRUIT_AIO_USERNAME = "your_aio_username"
ADAFRUIT_AIO_KEY = "your_aio_key"
```

Some projects use different variable names for the entries in the **settings.toml** file. For example, a project might use `ADAFRUIT_AIO_ID` in the place of `ADAFRUIT_AIO_USERNAME`. **If you run into connectivity issues, one of the first things to check is that the names in the settings.toml file match the names in the code.**

Warning: Not every project uses the same variable name for each entry in the **settings.toml** file! Always verify it matches the code.

## **settings.toml** File Tips
Here is an example **settings.toml** file.

```auto
# Comments are supported
CIRCUITPY_WIFI_SSID = "guest wifi"
CIRCUITPY_WIFI_PASSWORD = "guessable"
CIRCUITPY_WEB_API_PORT = 80
CIRCUITPY_WEB_API_PASSWORD = "passw0rd"
test_variable = "this is a test"
thumbs_up = "\U0001f44d"
```

In a **settings.toml** file, it's important to keep these factors in mind:

- Strings are wrapped in double quotes; ex: `"your-string-here"`
- Integers are _ **not** _ quoted and may be written in decimal with optional sign (`+1`, `-1`, `1000`) or hexadecimal (`0xabcd`).
  - Floats (decimal numbers), octal (`0o567`) and binary (`0b11011`) are not supported.

- Use `\u` escapes for weird characters, `\x` and `\ooo` escapes are not available in **.toml** files
  - Example: `\U0001f44d` for 👍 (thumbs up emoji) and `\u20ac` for € (EUR sign)

- Unicode emoji, and non-ASCII characters, stand for themselves as long as you're careful to save in "UTF-8 without BOM" format

&nbsp;

&nbsp;

When your&nbsp; **settings.toml&nbsp;** file is ready, you can save it in your text editor with the **.toml** &nbsp;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&nbsp;** file is used for connecting to your SSID and accessing your API keys.

# PyPortal Google Calendar Event Display

## Internet Connect!

# Connect to WiFi

OK, now that you have your&nbsp; **settings.toml** file set up - you can connect to the Internet.

To do this, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.

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

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

![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/esp32spi_esp32spi_simpletest.py.png )

Info: Update to CircuitPython 9.2.x or later to use this example.

https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_simpletest.py

And save it to your board, with the name **code.py**.

Don't forget you'll also need to create the **settings.toml** file as seen above, with your WiFi ssid and password.

In a serial console, you should see something like the following. For more information about connecting with a serial console, view the guide [Connecting to the Serial Console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console).

```terminal
&gt;&gt;&gt; import wifitest
ESP32 SPI webclient test
ESP32 found and in idle mode
Firmware vers. 1.7.5
MAC addr: 24:C9:DC:BD:0F:3F
	HomeNetwork             RSSI: -46
	HomeNetwork             RSSI: -76
	Fios-12345              RSSI: -92
	FiOS-AB123              RSSI: -92
	NETGEAR53               RSSI: -93
Connecting to AP...
Connected to HomeNetwork 	RSSI: -45
My IP address is 192.168.1.245
IP lookup adafruit.com: 104.20.39.240
Ping google.com: 30 ms
Fetching text from http://wifitest.adafruit.com/testwifi/index.html
----------------------------------------
This is a test of Adafruit WiFi!
If you can read this, its working :)
----------------------------------------

Fetching json from http://wifitest.adafruit.com/testwifi/sample.json
----------------------------------------
{'fun': True, 'company': 'Adafruit', 'founded': 2005, 'primes': [2, 3, 5], 'pi': 3.14, 'mixed': [False, None, 3, True, 2.7, 'cheese']}
----------------------------------------
Done!
```

Going over the example above, here's a breakdown of what the program is doing:

- Initialize the ESP32 over SPI using the SPI port and 3 control pins:

```python
esp32_cs = DigitalInOut(board.ESP_CS)
esp32_ready = DigitalInOut(board.ESP_BUSY)
esp32_reset = DigitalInOut(board.ESP_RESET)

#...

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

- Get the socket pool and the SSL context, and then tell the `adafruit_requests` library about them.

```python
pool = adafruit_connection_manager.get_radio_socketpool(esp)
ssl_context = adafruit_connection_manager.get_radio_ssl_context(esp)
requests = adafruit_requests.Session(pool, ssl_context)
```

- Verify an ESP32 is found, checks the firmware and MAC address

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

- Perform a scan of all access points it can see and print out the name and signal strength.

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

- Connect to the AP we've defined here, then print out the local IP address. Then attempt to do a domain name lookup and ping google.com to check network connectivity. (Note sometimes the ping fails or takes a while; this isn't a big deal.)

```python
print("Connecting to AP...")
while not esp.is_connected:
    try:
        esp.connect_AP(ssid, password)
    except OSError as e:
        print("could not connect to AP, retrying: ", e)
        continue
print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi)
print("My IP address is", esp.ipv4_address)
print(
    "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com"))
)
```

Now we're getting to the really interesting part of the example program. We've written a library for web fetching web data, named [adafruit\_requests](https://github.com/adafruit/Adafruit_CircuitPython_Requests). It is a lot like the regular Python library named [requests](https://requests.readthedocs.io/en/latest/). This library allows you to send HTTP and HTTPS requests easily and provides helpful methods for parsing the response from the server.

- Here is the part of the example program is fetching text data from a URL.

```python
TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"  # Further up in the program

# ...

print("Fetching text from", TEXT_URL)
r = requests.get(TEXT_URL)
print('-' * 40)
print(r.text)
print('-' * 40)
r.close()
```

- Finally, here the program is fetching some JSON data. The `adafruit_requests` library will parse the JSON into a Python dictionary whose structure is the same as the structure of the JSON.

```auto
JSON_URL = "http://wifitest.adafruit.com/testwifi/sample.json"   # Further up in the program

# ...

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

# Advanced Requests Usage

Want to send custom HTTP headers, parse the response as raw bytes, or handle a response's http status code in your CircuitPython code?

We've written an&nbsp;example to show advanced usage of the requests module below.

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

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

https://github.com/adafruit/Adafruit_CircuitPython_Requests/blob/main/examples/esp32spi/requests_esp32spi_advanced.py

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

![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/requests_esp32spi_requests_esp32spi_advanced.py.png )

# WiFi Manager

The way the examples above connect to WiFi works but it's a little finicky. Since WiFi is not necessarily so reliable, you may have disconnects and need to reconnect. For more advanced uses, we recommend using the `WiFiManager` class. It will wrap the connection/status/requests loop for you - reconnecting if WiFi drops, resetting the ESP32 if it gets into a bad state, etc.

Here's a more advanced example that shows using the `WiFiManager` and also how to fetch the current time from a web source.

https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_localtime.py

# Further Information

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

### Networking in CircuitPython

[Networking in CircuitPython](https://learn.adafruit.com/networking-in-circuitpython)
# PyPortal Google Calendar Event Display

## Setup Google Calendar API

Danger: This project's code uses the CircuitPython OAuth Library for authentication with Google services. Due to Google's update to the OAuth "authentication flow", the library became incompatible. As a result, this project does not currently work (but may in the future)!

## Obtain Access Tokens

Google provides a Calendar API which lets you access your Google account's calendar events. Let's start by creating an Application and register it with Google's API console.

Navigate to the&nbsp;[Google API Credentials page](https://console.developers.google.com/apis/credentials).&nbsp;

Click Create Credentials.

From the dropdown, select "OAuth client ID"

![projects_cred_1.png](https://cdn-learn.adafruit.com/assets/assets/000/098/620/medium640/projects_cred_1.png?1610558266)

![projects_oauth.png](https://cdn-learn.adafruit.com/assets/assets/000/098/621/medium640/projects_oauth.png?1610558275)

Select "TV and Limited Input devices" from the dropdown and give your client a name.

Click "Create".

![projects_tv_1.png](https://cdn-learn.adafruit.com/assets/assets/000/098/622/medium640/projects_tv_1.png?1610558300)

![projects_tv_2.png](https://cdn-learn.adafruit.com/assets/assets/000/098/623/medium640/projects_tv_2.png?1610558347)

Copy the Client ID and Client Secret to a text document and save it to your computer's desktop. You'll need these values later.

![projects_oauth_creds.png](https://cdn-learn.adafruit.com/assets/assets/000/098/626/medium640/projects_oauth_creds.png?1610558429)

Next, you'll need to authorize your email address. [This is a new step recently added by Google to increase the security of applications](https://stackoverflow.com/questions/65184355/error-403-access-denied-from-google-authentication-web-api-despite-google-acc).

Navigate to [https://console.cloud.google.com/apis/credentials/consent](https://console.cloud.google.com/apis/credentials/consent) and ensure the same project from before is selected.

Under User Type, select External.

Click Create.

![projects_oauth_consent_1.png](https://cdn-learn.adafruit.com/assets/assets/000/117/049/medium640/projects_oauth_consent_1.png?1670962166)

Name the App "MagTag Google Calendar" and use your email address in both email fields.

Click Save and Continue.

![projects_oauth_consent_2.png](https://cdn-learn.adafruit.com/assets/assets/000/117/050/medium640/projects_oauth_consent_2.png?1670962182)

Under Scopes, click Save and Continue.

![projects_add_users.png](https://cdn-learn.adafruit.com/assets/assets/000/117/054/medium640/projects_add_users.png?1670962453)

Click Add Users and add the email address belonging to the calendar you are viewing on the MagTag.

Click Save and Continue.

![projects_oauth_consent_4.png](https://cdn-learn.adafruit.com/assets/assets/000/117/051/medium640/projects_oauth_consent_4.png?1670962206)

![projects_oauth_5.png](https://cdn-learn.adafruit.com/assets/assets/000/117/052/medium640/projects_oauth_5.png?1670962229)

Ensure all the information you entered in the previous steps are correct, then click Save and Continue.

![projects_oauth_7.png](https://cdn-learn.adafruit.com/assets/assets/000/117/053/medium640/projects_oauth_7.png?1670962245)

# PyPortal Google Calendar Event Display

## Code Setup

Danger: This project's code uses the CircuitPython OAuth Library for authentication with Google services. Due to Google's update to the OAuth "authentication flow", the library became incompatible. As a result, this project does not currently work (but may in the future).


Before you can use the Google Calendar API to request events on your calendar, you must first authenticate the device with Google's authentication server.

We've handled this authorization "flow" by creating a CircuitPython library for [Google's implementation of OAuth2.0](https://github.com/adafruit/Adafruit_CircuitPython_OAuth2) and an application to run on your device.

Add the Google credentials you generated to s **ettings.toml**. Also add your Adafruit IO credentials, and a&nbsp;`TIMEZONE` value, which are used to find out what time it is.

```auto
CIRCUITPY_WIFI_SSID = "your_wifi_ssid"
CIRCUITPY_WIFI_PASSWORD = "your_wifi_password"
AIO_USERNAME = "your_aio_username"
AIO_KEY = "your_aio_key"
GOOGLE_CLIENT_ID = "YOUR_GOOGLE_CLIENT_ID"
GOOGLE_CLIENT_SECRET = "YOUR_GOOGLE_CLIENT_SECRET"
TIMEZONE = "Etc/UTC"
```

## Add CircuitPython Code and Project Assets

In the embedded code element below, click on the&nbsp; **Download Project Bundle** button, and save the .zip archive file to your computer.

Then,&nbsp;uncompress the .zip file, it will unpack to a folder named **PyPortal\_Google\_Calendar**

Copy the contents of the **PyPortal\_Google\_Calendar** &nbsp;directory to your PyPortal&nbsp; **CIRCUITPY** &nbsp;drive.

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_Google_Calendar/authenticator/code.py

Once all the files are copied from your computer to the CircuitPython device, you should have the following files on your **CIRCUITPY** drive.

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

## Authenticator Code Usage

On your **CIRCUITPY** drive, rename **authenticator.py** to **code.py**.

Then, open the CircuitPython REPL using Mu or another serial monitor.

Your PyPortal should boot into the Google Authenticator code and display a code and URL.

![circuitpython_IMG_9115.jpg](https://cdn-learn.adafruit.com/assets/assets/000/098/595/medium640/circuitpython_IMG_9115.jpg?1610488779)

Navigate to the [Google Device page](https://www.google.com/device) and enter the code you see on your device.

Click Next

![circuitpython_Sign_in_-_Google_Accounts.png](https://cdn-learn.adafruit.com/assets/assets/000/098/556/medium640/circuitpython_Sign_in_-_Google_Accounts.png?1610466800)

Select the Google Account you'd like to use with the calendar viewer.

- We are using the `https://www.googleapis.com/auth/calendar.readonly` scope which will gives an application read-only access to your calendar events.

![circuitpython_Sign_in_-_Google_Accounts.png](https://cdn-learn.adafruit.com/assets/assets/000/098/557/medium640/circuitpython_Sign_in_-_Google_Accounts.png?1610466846)

Since Google has not formally verified the application you created in the previous step, you'll be greeted with a warning.

- Click Advanced
- Then, Click the _Go to {your application name}&nbsp;_link

![circuitpython_Sign_in_-_Google_Accounts.png](https://cdn-learn.adafruit.com/assets/assets/000/098/558/medium640/circuitpython_Sign_in_-_Google_Accounts.png?1610466884)

![circuitpython_Sign_in_-_Google_Accounts.png](https://cdn-learn.adafruit.com/assets/assets/000/098/559/medium640/circuitpython_Sign_in_-_Google_Accounts.png?1610466947)

Finally, a dialog will appear displaying the application's requested permissions.

Click Allow.

You'll be presented with a dialog telling you the device has been authenticated.

![circuitpython_Sign_in_-_Google_Accounts.png](https://cdn-learn.adafruit.com/assets/assets/000/098/560/medium640/circuitpython_Sign_in_-_Google_Accounts.png?1610467027)

![circuitpython_Sign_in_-_Google_Accounts.png](https://cdn-learn.adafruit.com/assets/assets/000/098/566/medium640/circuitpython_Sign_in_-_Google_Accounts.png?1610467392)

After 5 seconds, the CircuitPython REPL should print out&nbsp; `GOOGLE_ACCESS_TOKEN` and `GOOGLE_REFRESH_TOKEN` values.

Copy and paste them into the **settings.toml** &nbsp;file.

```python
CIRCUITPY_WIFI_SSID = "your_wifi_ssid"
CIRCUITPY_WIFI_PASSWORD = "your_wifi_password"
AIO_USERNAME = "your_aio_username"
AIO_KEY = "your_aio_key"
GOOGLE_CLIENT_ID = "YOUR_GOOGLE_CLIENT_ID"
GOOGLE_CLIENT_SECRET = "YOUR_GOOGLE_CLIENT_SECRET"
TIMEZONE = "Etc/UTC"
GOOGLE_ACCESS_TOKEN = "YOUR_GOOGLE_ACCESS_TOKEN"
GOOGLE_REFRESH_TOKEN = "YOUR_GOOGLE_REFRESH_TOKEN"
```

Now that your device is authorized to make requests to the Google Calendar API, let's use it to fetch calendar events!

# PyPortal Google Calendar Event Display

## Code Usage

Danger: This project's code uses the CircuitPython OAuth Library for authentication with Google services. Due to Google's update to the OAuth "authentication flow", the library became incompatible. As a result, this project does not currently work (but may in the future).


## Code

Click the Download Project Bundle button below to get the CircuitPython code, the needed libraries, the fonts and the authenticator app.&nbsp;

Copy **code.py** and the **lib** and **fonts** folders to the root directory of your **CIRCUITPY** drive in File Explorer or Finder (depending on your operating system). This should overwrite the authenticator code with the calendar event display code.

https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_Google_Calendar/code.py

You should have the following files on your **CIRCUITPY** drive.

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

If you're missing any files, look in the Download Project Bundle zip file and copy what you're missing.

## Set Google Calendar ID

Before using this code with your calendar, you'll need to obtain the Google calendar's unique identifier. Navigate to [the Google Calendar Settings Page](https://calendar.google.com/calendar/u/0/r/settings) and click the calendar you'd like to display on the PyPortal.

Before using this code with your calendar, you'll need to obtain the Google calendar's unique identifier.

Navigate to&nbsp;[the Google Calendar Settings Page](https://calendar.google.com/calendar/u/0/r/settings)&nbsp;and click the calendar you'd like to display on the PyPortal.

![circuitpython_Google_Calendar_-_General_settings.png](https://cdn-learn.adafruit.com/assets/assets/000/098/567/medium640/circuitpython_Google_Calendar_-_General_settings.png?1610468878)

Scroll down on the page until you see the Calendar ID.

Copy this value to your clipboard.

![circuitpython_Google_Calendar_-_Calendar_settings_for_Meetings.png](https://cdn-learn.adafruit.com/assets/assets/000/098/568/medium640/circuitpython_Google_Calendar_-_Calendar_settings_for_Meetings.png?1610468974)

In the **code.py** file, set `CALENDAR_ID` using the calendar ID you obtained above.

`CALENDAR_ID = "YOUR_CALENDAR_ID"`

## Code Usage
Every 15 minutes, the PyPortal will attempt to fetch your calendar's latest events and display three of them on the screen.&nbsp;

Once an event finishes and the PyPortal refreshes, it will be removed from the display.

![circuitpython_IMG_9192.jpg](https://cdn-learn.adafruit.com/assets/assets/000/098/616/medium640/circuitpython_IMG_9192.jpg?1610551563)

## Change the refresh rate

After fetching and displaying calendar events, the waits for 15 minutes. Modify the following line in the code to reflect how long the PyPortal will wait between refreshing the calendar events, in minutes.

```python
# Amount of time to wait between refreshing the calendar, in minutes
REFRESH_TIME = 15
```

# PyPortal Google Calendar Event Display

## Code Walkthrough

Danger: This project's code uses the CircuitPython OAuth Library for authentication with Google services. Due to Google's update to the OAuth "authentication flow", the library became incompatible. As a result, this project does not currently work (but may in the future).


The Google Calendar Event Display code uses [the Google Calendar API's Event list endpoint](https://developers.google.com/calendar/v3/reference/events/list) to return events from a specific calendar.

The results from a GET request to this endpoint will look something like the following:

```python
{
 "kind": "calendar#events",
 "etag": "\"p32c9b6vtqmbes0g\"",
 "summary": "Meetings",
 "updated": "2021-01-12T15:06:56.911Z",
 "timeZone": "America/New_York",
 "accessRole": "owner",
 "defaultReminders": [],
 "nextPageToken": "CigKGjMyajF0bm0xcmwzbDBnbWhmNTNyaW9xb3B2GAEggIDA3tm_zrYXGg0IABIAGJiVm_3Vlu4CIgcIBBC35scP",
 "items": [
  {
   "kind": "calendar#event",
   "etag": "\"3219736474490000\"",
   "id": "32j1tnm1rl3l0gmhf53rioqopv",
   "status": "confirmed",
   "htmlLink": "https://www.google.com/calendar/event?eid=MzJqMXRubTFybDNsMGdtaGY1M3Jpb3FvcHYgYWpmb242cGhsN24xZG1wanNkbGV2dHFhMDRAZw",
   "created": "2021-01-05T17:35:02.000Z",
   "updated": "2021-01-05T17:37:17.245Z",
   "summary": "Adafruit Show and Tell",
   "creator": {
    "email": ""
   },
   "organizer": {
    "email": "@group.calendar.google.com",
    "displayName": "Meetings",
    "self": true
   },
   "start": {
    "dateTime": "2021-01-06T19:30:00-05:00"
   },
   "end": {
    "dateTime": "2021-01-06T20:00:00-05:00"
   },
   "iCalUID": "@google.com",
   "sequence": 0,
   "reminders": {
    "useDefault": true
   }
  }
 ]
}
```

All events are kept within an `items` array which contains detailed information about each event. The code parses this array for the event's `summary` and the event's `start` `dateTime`.&nbsp;

## Refreshing Google API Access Token

The Google Calendar API access token expires after a specific time interval. If the access token is expired, the refresh token in **secrets.py** is used to POST a request to Google's servers for a new access token.

```python
if (int(time.monotonic()) - access_token_obtained&gt;= google_auth.access_token_expiration):
  print("Access token expired, refreshing...")
  if not google_auth.refresh_access_token():
    raise RuntimeError(
      "Unable to refresh access token - has the token been revoked?"
    )
    access_token_obtained = int(time.monotonic())
```

## Fetching Calendar Events

Prior to calling Google Calendar, a timestamp must be obtained to display the latest events in ascending order. The code calls the Adafruit IO time service to fetch and set the timestamp we'll use for requesting data from Google Calendar.

```python
# fetch calendar events!
print("fetching local time...")
now = get_current_time()
```

We'll display the current date at the top of the PyPortal. Passing a `pretty_date` argument formats the [struct\_time](https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/index.html#time.struct_time) timestamp into a human-readable timestamp such as "January 6th, 2021"

```python
# setup header label
pyportal.set_text(format_datetime(now, pretty_date=True), label_header)
```

Within `get_calendar_events`, we perform a HTTP GET to Google Calendar API's event list endpoint

```python
def display_calendar_events(resp_events):
    # Display all calendar events
    for event_idx in range(len(resp_events)):
        event = resp_events[event_idx]
        # wrap event name around second line if necessary
        event_name = PyPortal.wrap_nicely(event["summary"], 25)
        event_name = "\n".join(event_name[0:2])  # only wrap 2 lines, truncate third..
        event_start = event["start"]["dateTime"]
        print("-" * 40)
        print("Event Description: ", event_name)
        print("Event Time:", format_datetime(event_start))
        print("-" * 40)
        pyportal.set_text(format_datetime(event_start), event_labels[event_idx][0])
        pyportal.set_text(event_name, event_labels[event_idx][1])

    # Clear any unused labels
    for event_idx in range(len(resp_events), MAX_EVENTS):
        pyportal.set_text("", event_labels[event_idx][0])
        pyportal.set_text("", event_labels[event_idx][1])
```

Finally, the display elements are displayed on the screen and the PyPortal sleeps for `REFRESH_TIME` minutes.

```python
print("displaying events")
display_calendar_events(events)

print("Sleeping for %d minutes" % REFRESH_TIME)
time.sleep(REFRESH_TIME * 60)
```


## 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&nbsp;tinyJSON / APIs to get news, stock, weather, cat photos,...

In 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&nbsp;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)
### 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)
- [CircuitPython Your Own Adventure](https://learn.adafruit.com/circuit-python-your-own-adventure.md)
- [PyPortal Cutefuzz Image Viewer](https://learn.adafruit.com/pyportal-cutefuzz-image-viewer.md)
- [PyPortal IoT Plant Monitor with AWS IoT and CircuitPython](https://learn.adafruit.com/pyportal-iot-plant-monitor-with-aws-iot-and-circuitpython.md)
- [PyPortal Halloween Countdown](https://learn.adafruit.com/pyportal-halloween-countdown.md)
- [How to Make Animated Graphics for Hologram Displays](https://learn.adafruit.com/how-to-make-animated-graphics-for-hologram-displays.md)
- [PyPortal Weekly Countdown Clock](https://learn.adafruit.com/pyportal-countdown-clock.md)
- [PyPortal Air Quality Display](https://learn.adafruit.com/pyportal-air-quality-display.md)
- [Program CircuitPython USB Devices with iPhone & iPad](https://learn.adafruit.com/use-circuitpython-devices-with-iphone-ipad.md)
- [PyPortal GitHub Stars Trophy](https://learn.adafruit.com/pyportal-github-stars-trophy.md)
- [PyPortal IoT Weather Station](https://learn.adafruit.com/pyportal-iot-weather-station.md)
- [PyPortal Philips Hue Lighting Controller](https://learn.adafruit.com/pyportal-philips-hue-lighting-controller.md)
- [PyPortal Wake-Up Light Alarm Clock](https://learn.adafruit.com/pyportal-wake-up-light.md)
- [Infinite Text Adventure](https://learn.adafruit.com/infinite-text-adventure.md)
- [PyPortal Wall Mount](https://learn.adafruit.com/pyportal-wall-mount.md)
- [Adafruit IO Basics: AirLift](https://learn.adafruit.com/adafruit-io-basics-airlift.md)
