# PyPortal LIFX Lighting Controller ## Overview ![](https://cdn-learn.adafruit.com/assets/assets/000/074/041/medium800thumb/internet_of_things___iot_ezgif.com-video-to-gif_%287%29.jpg?1554410524) **_Want to add unique lighting to your room?_ ** A simple solution would be adding a couple of **WiFi-enabled LED smart-bulbs**. These bulbs are energy efficient and come in a variety of shapes, sizes, and colors to fit your space. Smaller bulbs can be used for accent-lighting or lamps, while larger bulbs are more powerful and can light up an entire room! These types of bulbs are _incredibly_ popular - and are sold in most major electronics brick-and-mortar retailers.  In this guide, **you'll be turning your PyPortal into a smart lighting controller capable of selecting and setting multiple light sources**. ![](https://cdn-learn.adafruit.com/assets/assets/000/073/550/medium800/internet_of_things___iot_ProductLineUpAbout.jpg?1553265653 The LIFX family of smart-bulbs (src: https://www.lifx.com/pages/about)) Unlike a more complicated smart-lighting system like the [popular Phillips Hue](https://www2.meethue.com/en-us), LIFX lights are incredibly simple to setup. each light has its own wifi radio (_possibly something [ESP32](https://www.adafruit.com/product/3979) or [ESP8266](https://www.adafruit.com/product/2491)-based?_ We can't tell from [the teardown photo](https://www.ifixit.com/Teardown/LIFX+Color+1000+Teardown/64739)) and connects to your WiFi network. Most notable about the LIFX lights is they provide [a well-documented HTTP API](https://api.developer.lifx.com/docs/introduction), similar to the [Adafruit IO HTTP API](https://io.adafruit.com/api/docs/). This means you can easily interface with it using your PyPortal. If you're looking for a way to **interactively control a room's lighting using your PyPortal** , follow along! ## CircuitPython Code CircuitPython is perfect for building Internet-of-Things projects. This project uses the [ESP32SPI CircuitPython](https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI)library, which can use the ESP32 as a WiFi-coprocessor to send web requests to the LIFX HTTP Remote Control API. We've also built a [LIFX helper module for CircuitPython](https://github.com/adafruit/Adafruit_CircuitPython_LIFX) to make interfacing with these lights incredibly easy.  You can rapidly update your code without having to compile and store WiFi and API secret keys on the device. This means that there's no editing code and re-uploading whenever you move the PyPortal to another network - just update a file and you're set.  ![internet_of_things___iot_updated_code.png](https://cdn-learn.adafruit.com/assets/assets/000/074/096/medium640/internet_of_things___iot_updated_code.png?1554495184) ## PyPortal Say hello to PyPortal! The easiest way to build your IoT projects with a touchscreen display! [Make sure to walk through the PyPortal introduction guide and walkthrough the pages. It'll get you setup with CircuitPython and a handful of demo code to play with!](https://learn.adafruit.com/adafruit-pyportal) ![internet_of_things___iot_3d_printing_hero_(1).jpg](https://cdn-learn.adafruit.com/assets/assets/000/073/554/medium640/internet_of_things___iot_3d_printing_hero_%281%29.jpg?1553269080) ## Prerequisite Guides If you're new to CircuitPython, take a moment to walk through the following guides to get you started and up-to-speed: - [Welcome to CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython) ## Parts You only need a PyPortal for this guide - no other sensors or external circuitry required! ### 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,... 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) ### Part: USB Cable quantity: 1 USB cable - USB A to Micro-B - 3 foot long [USB Cable](https://www.adafruit.com/product/592) You can get both of these and a PyPortal stand in AdaBox 011: # PyPortal LIFX Lighting Controller ## PyPortal CircuitPython Setup To use all the amazing features of your PyPortal with CircuitPython, you must first install a number of libraries. This page covers that process. # Adafruit CircuitPython Bundle Download the Adafruit CircuitPython Library Bundle. You can find the latest release here: [Latest Adafruit CircuitPython Library Bundle](https://circuitpython.org/libraries) Download the **adafruit-circuitpython-bundle-\*.x-mpy-\*.zip** bundle zip file where **\*.x MATCHES THE VERSION OF CIRCUITPYTHON YOU INSTALLED** , and unzip a folder of the same name. Inside you'll find a **lib** folder. You have two options: - You can add the **lib** folder to your **CIRCUITPY** drive. This will ensure you have _all the drivers_. But it will take a bunch of space on the 8 MB disk - Add each library as you need it, this will reduce the space usage but you'll need to put in a little more effort. At a minimum we recommend the following libraries, in fact we more than recommend. They're basically required. So grab them and install them into **CIRCUITPY/lib** now! - **adafruit\_esp32spi** - This is the library that gives you internet access via the ESP32 using (you guessed it!) SPI transport. You need this for anything Internet - **adafruit\_requests** - This library allows us to perform HTTP requests and get responses back from servers. GET/POST/PUT/PATCH - they're all in here! - adafruit\_connection\_manager - used by adafruit\_requests. - **adafruit\_pyportal** - This is our friendly wrapper library that does a lot of our projects, displays graphics and text, fetches data from the internet. Nearly all of our projects depend on it! - **adafruit\_portalbase**  - This library is the base library that adafruit\_pyportal library is built on top of. - **adafruit\_touchscreen** - a library for reading touches from the resistive touchscreen. Handles all the analog noodling, rotation and calibration for you. - **adafruit\_io** - this library helps connect the PyPortal to our free datalogging and viewing service - **adafruit\_imageload** - an image display helper, required for any graphics! - **adafruit\_display\_text** - not surprisingly, it displays text on the screen - **adafruit\_bitmap\_font** - we have fancy font support, and its easy to make new fonts. This library reads and parses font files. - **adafruit\_slideshow** - for making image slideshows - handy for quick display of graphics and sound - **neopixel** - for controlling the onboard neopixel - **adafruit\_adt7410** - library to read the temperature from the on-board Analog Devices ADT7410 precision temperature sensor (not necessary for Titano or Pynt) - **adafruit\_bus\_device** - low level support for I2C/SPI - **adafruit\_fakerequests**  - This library allows you to create fake HTTP requests by using local files. # PyPortal LIFX Lighting Controller ## Create Your settings.toml File CircuitPython works with WiFi-capable boards to enable you to make projects that have network connectivity. This means working with various passwords and API keys. As of [CircuitPython 8](https://circuitpython.org/downloads), there is support for a **settings.toml** file. This is a file that is stored on your **CIRCUITPY** drive, that contains all of your secret network information, such as your SSID, SSID password and any API keys for IoT services. It is designed to separate your sensitive information from your **code.py** file so you are able to share your code without sharing your credentials. CircuitPython previously used a **secrets.py** file for this purpose. The **settings.toml** file is quite similar. Warning: Your **settings.toml** file should be stored in the main directory of your **CIRCUITPY** drive. It should not be in a folder. ## CircuitPython **settings.toml** File This section will provide a couple of examples of what your **settings.toml** file should look like, specifically for CircuitPython WiFi projects in general. The most minimal **settings.toml** file must contain your WiFi SSID and password, as that is the minimum required to connect to WiFi. Copy this example, paste it into your **settings.toml** , and update: - `your_wifi_ssid` - `your_wifi_password` ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" ``` Many CircuitPython network-connected projects on the Adafruit Learn System involve using Adafruit IO. For these projects, you must _also_ include your Adafruit IO username and key. Copy the following example, paste it into your settings.toml file, and update: - `your_wifi_ssid` - `your_wifi_password` - `your_aio_username` - `your_aio_key` ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" ADAFRUIT_AIO_USERNAME = "your_aio_username" ADAFRUIT_AIO_KEY = "your_aio_key" ``` Some projects use different variable names for the entries in the **settings.toml** file. For example, a project might use `ADAFRUIT_AIO_ID` in the place of `ADAFRUIT_AIO_USERNAME`. **If you run into connectivity issues, one of the first things to check is that the names in the settings.toml file match the names in the code.** Warning: Not every project uses the same variable name for each entry in the **settings.toml** file! Always verify it matches the code. ## **settings.toml** File Tips Here is an example **settings.toml** file. ```auto # Comments are supported CIRCUITPY_WIFI_SSID = "guest wifi" CIRCUITPY_WIFI_PASSWORD = "guessable" CIRCUITPY_WEB_API_PORT = 80 CIRCUITPY_WEB_API_PASSWORD = "passw0rd" test_variable = "this is a test" thumbs_up = "\U0001f44d" ``` In a **settings.toml** file, it's important to keep these factors in mind: - Strings are wrapped in double quotes; ex: `"your-string-here"` - Integers are _ **not** _ quoted and may be written in decimal with optional sign (`+1`, `-1`, `1000`) or hexadecimal (`0xabcd`). - Floats (decimal numbers), octal (`0o567`) and binary (`0b11011`) are not supported. - Use `\u` escapes for weird characters, `\x` and `\ooo` escapes are not available in **.toml** files - Example: `\U0001f44d` for 👍 (thumbs up emoji) and `\u20ac` for € (EUR sign) - Unicode emoji, and non-ASCII characters, stand for themselves as long as you're careful to save in "UTF-8 without BOM" format     When your  **settings.toml ** file is ready, you can save it in your text editor with the **.toml**  extension. ![adafruit_products_dotToml.jpg](https://cdn-learn.adafruit.com/assets/assets/000/117/071/medium640/adafruit_products_dotToml.jpg?1671034293) ## Accessing Your **settings.toml** Information in **code.py** In your **code.py** file, you'll need to `import` the `os` library to access the **settings.toml** file. Your settings are accessed with the `os.getenv()` function. You'll pass your settings entry to the function to import it into the **code.py** file. ```python import os print(os.getenv("test_variable")) ``` ![](https://cdn-learn.adafruit.com/assets/assets/000/117/072/medium800/adafruit_products_tomlOutput.jpg?1671034496) In the upcoming CircuitPython WiFi examples, you'll see how the **settings.toml ** file is used for connecting to your SSID and accessing your API keys. # PyPortal LIFX Lighting Controller ## Internet Connect! # Connect to WiFi OK, now that you have your  **settings.toml** file set up - you can connect to the Internet. To do this, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script. Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **examples/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive. Your **CIRCUITPY** drive should now look similar to the following image: ![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/esp32spi_esp32spi_simpletest.py.png ) Info: Update to CircuitPython 9.2.x or later to use this example. https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_simpletest.py And save it to your board, with the name **code.py**. Don't forget you'll also need to create the **settings.toml** file as seen above, with your WiFi ssid and password. In a serial console, you should see something like the following. For more information about connecting with a serial console, view the guide [Connecting to the Serial Console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console). ```terminal >>> import wifitest ESP32 SPI webclient test ESP32 found and in idle mode Firmware vers. 1.7.5 MAC addr: 24:C9:DC:BD:0F:3F HomeNetwork RSSI: -46 HomeNetwork RSSI: -76 Fios-12345 RSSI: -92 FiOS-AB123 RSSI: -92 NETGEAR53 RSSI: -93 Connecting to AP... Connected to HomeNetwork RSSI: -45 My IP address is 192.168.1.245 IP lookup adafruit.com: 104.20.39.240 Ping google.com: 30 ms Fetching text from http://wifitest.adafruit.com/testwifi/index.html ---------------------------------------- This is a test of Adafruit WiFi! If you can read this, its working :) ---------------------------------------- Fetching json from http://wifitest.adafruit.com/testwifi/sample.json ---------------------------------------- {'fun': True, 'company': 'Adafruit', 'founded': 2005, 'primes': [2, 3, 5], 'pi': 3.14, 'mixed': [False, None, 3, True, 2.7, 'cheese']} ---------------------------------------- Done! ``` Going over the example above, here's a breakdown of what the program is doing: - Initialize the ESP32 over SPI using the SPI port and 3 control pins: ```python esp32_cs = DigitalInOut(board.ESP_CS) esp32_ready = DigitalInOut(board.ESP_BUSY) esp32_reset = DigitalInOut(board.ESP_RESET) #... else: spi = busio.SPI(board.SCK, board.MOSI, board.MISO) esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) ``` - Get the socket pool and the SSL context, and then tell the `adafruit_requests` library about them. ```python pool = adafruit_connection_manager.get_radio_socketpool(esp) ssl_context = adafruit_connection_manager.get_radio_ssl_context(esp) requests = adafruit_requests.Session(pool, ssl_context) ``` - Verify an ESP32 is found, checks the firmware and MAC address ```auto if esp.status == adafruit_esp32spi.WL_IDLE_STATUS: print("ESP32 found and in idle mode") print("Firmware vers.", esp.firmware_version) print("MAC addr:", ":".join("%02X" % byte for byte in esp.MAC_address)) ``` - Perform a scan of all access points it can see and print out the name and signal strength. ```python for ap in esp.scan_networks(): print("\t%-23s RSSI: %d" % (ap.ssid, ap.rssi)) ``` - Connect to the AP we've defined here, then print out the local IP address. Then attempt to do a domain name lookup and ping google.com to check network connectivity. (Note sometimes the ping fails or takes a while; this isn't a big deal.) ```python print("Connecting to AP...") while not esp.is_connected: try: esp.connect_AP(ssid, password) except OSError as e: print("could not connect to AP, retrying: ", e) continue print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi) print("My IP address is", esp.ipv4_address) print( "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com")) ) ``` Now we're getting to the really interesting part of the example program. We've written a library for web fetching web data, named [adafruit\_requests](https://github.com/adafruit/Adafruit_CircuitPython_Requests). It is a lot like the regular Python library named [requests](https://requests.readthedocs.io/en/latest/). This library allows you to send HTTP and HTTPS requests easily and provides helpful methods for parsing the response from the server. - Here is the part of the example program is fetching text data from a URL. ```python TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html" # Further up in the program # ... print("Fetching text from", TEXT_URL) r = requests.get(TEXT_URL) print('-' * 40) print(r.text) print('-' * 40) r.close() ``` - Finally, here the program is fetching some JSON data. The `adafruit_requests` library will parse the JSON into a Python dictionary whose structure is the same as the structure of the JSON. ```auto JSON_URL = "http://wifitest.adafruit.com/testwifi/sample.json" # Further up in the program # ... print("Fetching json from", JSON_URL) r = requests.get(JSON_URL) print('-' * 40) print(r.json()) print('-' * 40) r.close() ``` # Advanced Requests Usage Want to send custom HTTP headers, parse the response as raw bytes, or handle a response's http status code in your CircuitPython code? We've written an example to show advanced usage of the requests module below. To use with CircuitPython, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script. Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **examples/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive. https://github.com/adafruit/Adafruit_CircuitPython_Requests/blob/main/examples/esp32spi/requests_esp32spi_advanced.py Your **CIRCUITPY** drive should now look similar to the following image: ![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/requests_esp32spi_requests_esp32spi_advanced.py.png ) # WiFi Manager The way the examples above connect to WiFi works but it's a little finicky. Since WiFi is not necessarily so reliable, you may have disconnects and need to reconnect. For more advanced uses, we recommend using the `WiFiManager` class. It will wrap the connection/status/requests loop for you - reconnecting if WiFi drops, resetting the ESP32 if it gets into a bad state, etc. Here's a more advanced example that shows using the `WiFiManager` and also how to fetch the current time from a web source. https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_localtime.py # Further Information For more information on the basics of doing networking in CircuitPython, see this guide: ### Networking in CircuitPython [Networking in CircuitPython](https://learn.adafruit.com/networking-in-circuitpython) # PyPortal LIFX Lighting Controller ## Code PyPortal with CircuitPython ## Obtain your LIFX Access Token All requests to the LIFX bulbs require an **access token**. Obtaining one is simple! **Navigate** **to** [the LIFX account settings page](https://cloud.lifx.com/settings), **name your access token** something unique, and **click generate**. Then, **copy this token to a file or somewhere safe**  - you will **not** be able to view it again when you navigate away from this page. ![internet_of_things___iot_LIFX_Cloud.png](https://cdn-learn.adafruit.com/assets/assets/000/073/556/medium640/internet_of_things___iot_LIFX_Cloud.png?1553267101) ![internet_of_things___iot_TOKEN.png](https://cdn-learn.adafruit.com/assets/assets/000/073/560/medium640/internet_of_things___iot_TOKEN.png?1553267336) ## CircuitPython Library Installation First make sure you are running the [latest version of Adafruit CircuitPython](https://circuitpython.org/board/pyportal/) 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://github.com/adafruit/Adafruit_CircuitPython_Bundle) matching your version of CircuitPython. PyPortal requires at least CircuitPython version 4.0.0. Before continuing make sure your board's **lib** folder has the following files and folders ** ** copied over. - **adafruit\_lifx** - **adafruit\_bitmap\_font** - **adafruit\_bus\_device** - **adafruit\_button** - **adafruit\_display\_shapes** - **adafruit\_display\_text** - **adafruit\_esp32spi** - **adafruit\_touchscreen** - **neopixel** **Add the LIFX Access Token** you generated to to your **settings.toml**  file: ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" LIFX_TOKEN = "_your_really_long_lifx_token_" ``` ## Add CircuitPython Code and Project Assets 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\_lifx\_controller**. Copy the contents of the  **pyportal\_lifx\_controller** directory to your PyPortal **CIRCUITPY**  drive. https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_LIFX_Controller/code.py This is what the final contents of the  **CIRCUITPY**  drive will look like: ![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/PyPortal_PyPortal_LIFX_Controller.png ) ## Setup Code **Before you can use the code, you'll need to modify the ** code.py ** file to add a label specifying which light you're controlling.** LIFX uses an identifier called a [selector](https://api.developer.lifx.com/docs/selectors) to identify the lights associated with your account. With a selector, you can use the light's unique identifier, location (bedroom, workbench, living room) or lighting groups. For simplicity, this guide assumes that you will be using a label as a selector. **To find the bulb's label:** **Navigate to the LIFX app**  and select the light you'd like to control. **Tap** the gear icon to reveal the detailed settings of the light. The **Name** of the light is the light's label.  ![internet_of_things___iot_Pasted_Image_3_22_19__11_38_AM.png](https://cdn-learn.adafruit.com/assets/assets/000/073/562/medium640/internet_of_things___iot_Pasted_Image_3_22_19__11_38_AM.png?1553269116) ![internet_of_things___iot_IMG_3419.png](https://cdn-learn.adafruit.com/assets/assets/000/073/563/medium640/internet_of_things___iot_IMG_3419.png?1553269133) Next, modify the `lifx_lights` variable within **code.py**  to include the label from the App **.** For example, if you're adding a new LIFX bulb called **workbench** , change the code _from_ `lifx_lights = ['label:lamp', 'label:Main Room']` _ **to** _ `lifx_lights = ['label:lamp', 'label:workbench']` **Be sure to include** **`label:`** before the name of your light. For more information on using LIFX light selectors, [check out their API documentation on this topic here](https://api.developer.lifx.com/docs/selectors). ## Code Usage From the Mu Editor,  **click the Serial button**  to open the REPL. You should see the REPL display the code's status as it loads the interface. ![internet_of_things___iot_IMG_7651.jpg](https://cdn-learn.adafruit.com/assets/assets/000/074/035/medium640/internet_of_things___iot_IMG_7651.jpg?1554408220) **Select a light by tapping the name of the light you'd like to control.** If none is selected, the code will default to the first light specified within the `lifx_lights` list. ![internet_of_things___iot_ezgif.com-video-to-gif_(6).gif](https://cdn-learn.adafruit.com/assets/assets/000/074/036/medium640thumb/internet_of_things___iot_ezgif.com-video-to-gif_%286%29.jpg?1554408395) **Tap the on/off button ** to toggle the power of the light you selected. Keep in mind that LIFX lights save state - if your light was previously set to **red** and turned off, it'll turn on with the same color. - **Buttons invert their color while they make a request** to the LIFX API. **Once the request is complete, the button changes back to its original color.**   - **If you're having issues with your light not responding:**  scroll down to the _Diagnosing Errors_ section below. ![internet_of_things___iot_ezgif.com-video-to-gif_(5).gif](https://cdn-learn.adafruit.com/assets/assets/000/074/033/medium640thumb/internet_of_things___iot_ezgif.com-video-to-gif_%285%29.jpg?1554407612) **Tapping a color button will set the light to the button's fill color** with the brightness specified by the _+_ or _-_ buttons. - Note: We used the color names for this guide to set different colors. [The LIFX HTTP Remote Control API allows you to go beyond basic colors - you can set a bulb's color by specifying hue, saturation, brightness, kelvin or hex values.](https://api.developer.lifx.com/docs/colors) ![](https://cdn-learn.adafruit.com/assets/assets/000/074/040/medium800thumb/internet_of_things___iot_ezgif.com-video-to-gif_%287%29.jpg?1554410583) Next up, we'll take a look at the code you loaded onto your PyPortal # PyPortal LIFX Lighting Controller ## Code Walkthrough ## Importing Libraries ```auto from os import getenv import board import displayio from adafruit_bitmap_font import bitmap_font from adafruit_button import Button import adafruit_touchscreen from digitalio import DigitalInOut import busio import neopixel from adafruit_esp32spi import adafruit_esp32spi from adafruit_esp32spi import adafruit_esp32spi_wifimanager import adafruit_lifx ``` The code first imports all of the libraries required to run the Smart Lighting Controller.  **Note** that the code imports a special `adafruit_lifx` library. To communicate with the LIFX API, we wrote a CircuitPython helper module called `CircuitPython_LIFX`. This module makes HTTP requests ( or, "talks") to the LIFX API server in order to interact with the bulbs. - For more information about how HTTP works, check out our [All The Internet of Things guide on this topic here](https://learn.adafruit.com/alltheiot-protocols/http). ## Configuring the PyPortal ```auto # ESP32 SPI esp32_cs = DigitalInOut(board.ESP_CS) esp32_ready = DigitalInOut(board.ESP_BUSY) esp32_reset = DigitalInOut(board.ESP_RESET) spi = busio.SPI(board.SCK, board.MOSI, board.MISO) esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # These pins are used as both analog and digital! XL, XR and YU must be analog # and digital capable. YD just need to be digital ts = adafruit_touchscreen.Touchscreen(board.TOUCH_XL, board.TOUCH_XR, board.TOUCH_YD, board.TOUCH_YU, calibration=((5200, 59000), (5800, 57000)), size=(320, 240)) ``` The next chunk of code grabs information from a **settings.toml** file including wifi configuration and your LIFX Access Token. Then, it sets up the ESP32's SPI connections for use with the PyPortal. The `wifi` object is set up here too - it's used later in the code to communicate with the LIFX API.  ## Configuring the LIFX Helper Module ```auto # Set this to your LIFX personal access token in settings.toml # (to obtain a token, visit: https://cloud.lifx.com/settings) lifx_token = getenv("LIFX_TOKEN") # Initialize the LIFX API Helper lifx = adafruit_lifx.LIFX(wifi, lifx_token) # Set these to your LIFX light selector (https://api.developer.lifx.com/docs/selectors) lifx_lights = ['label:Lamp', 'label:Bedroom'] # set default light properties current_light = lifx_lights[0] light_brightness = 1.0 ``` The `lifx_token` entry within **settings.toml** is set to a new variable, `lifx_token`, and passed into the LIFX helper along with the wifi object created earlier. Then, the code sets up a list of two lights (identified by[their selectors](https://api.developer.lifx.com/docs/selectors)). Later in this code, these lights are linked to buttons so the code can identify which light is being toggled.  Also, a default light brightness of 100% is set, along with a `current_light` variable used to track the light being addressed. ## Button Setup ```auto # Make the display context button_group = displayio.Group() board.DISPLAY.root_group = button_group # preload the font print('loading font...') font = bitmap_font.load_font("/fonts/Arial-12.bdf") glyphs = b'0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-,.: ' font.load_glyphs(glyphs) # button properties BUTTON_WIDTH = 60 BUTTON_HEIGHT = 60 buttons = [] ``` Before the code can create buttons, it needs to create a `displayio` group to hold them. Here - the code selects a font, preloads it with glyphs, and sets button properties for `BUTTON_WIDTH` and `BUTTON_HEIGHT`. ## Button Generation ``` # list of color buttons and their properties color_btn = [ {'name':'red', 'pos':(15, 80), 'color':button_colors['red']}, {'name':'white', 'pos':(85, 80), 'color':button_colors['white']}, {'name':'orange', 'pos':(155, 80), 'color':button_colors['orange']}, {'name':'yellow', 'pos':(225, 80), 'color':button_colors['yellow']}, {'name':'pink', 'pos':(15, 155), 'color':button_colors['pink']}, {'name':'green', 'pos':(85, 155), 'color':button_colors['green']}, {'name':'blue', 'pos':(155, 155), 'color':button_colors['blue']}, {'name':'purple', 'pos':(225, 155), 'color':button_colors['purple']} ] # generate color buttons from color_btn list for i in color_btn: button = Button(x=i['pos'][0], y=i['pos'][1], width=BUTTON_WIDTH, height=BUTTON_HEIGHT, name=i['name'], fill_color=i['color'], style=Button.ROUNDRECT) buttons.append(button) # light property buttons and their properties prop_btn = [ {'name':'onoff', 'pos':(15, 15), 'label':'on/off'}, {'name':'up', 'pos':(75, 15), 'label':'+'}, {'name':'down', 'pos':(135, 15), 'label':'-'}, {'name':'lamp', 'pos':(195, 15), 'label':'lamp'}, {'name':'room', 'pos':(245, 15), 'label':'room'} ] # generate property buttons from prop_btn list for i in prop_btn: button = Button(name=i['name'], x=i['pos'][0], y=i['pos'][1], width=40, height=40, label=i['label'], label_font=font, style=Button.SHADOWROUNDRECT) buttons.append(button) # add buttons to the group for b in buttons: button_group.append(b.group) ``` The next chunk of code creates buttons for the light colors and properties. First, a list of dictionary items is created corresponding to button properties. The `color_btn` list contains information for the button such as the button's name, position on the display, and hex color value. The `prop_btn` list contains the button's name, position and text label. Then, buttons are generated from the list and appended to a `button` list. When all the buttons have been added to `button` list, they are appended to the displayio `button_group` one-by-one. ## Main Loop ``` while True: touch = ts.touch_point if touch: for i, button in enumerate(buttons): if button.contains(touch): button.selected = True ``` The main loop checks for if the screen was touched. If it was, it searches for which button in the `button` list was touched. Once the button was determined, the button's `selected` property is toggled - inverting the button's color until the action is performed. By doing this, you are creating a visual status indicator. ``` if button.name == 'lamp': current_light = lifx_lights[0] print('Switching to ', current_light) elif button.name == 'room': current_light = lifx_lights[1] print('Switching to ', current_light) ``` Then, the code checks the button's name against its function (what it does). If the button's name is lamp or room, `current_light` is toggled to the value of the button. Whenever the code in the main loop sends data to the LIFX API to perform an action on a light, it uses the `current_light` variable to select the light. ``` elif button.name == 'onoff': print('Toggling {0}...'.format(current_light)) lifx.toggle_light(current_light) elif button.name == 'up': light_brightness += 0.25 print('Setting {0} brightness to {1}'.format(current_light, light_brightness)) lifx.set_brightness(current_light, light_brightness) elif button.name == 'down': light_brightness -= 0.25 print('Setting {0} brightness to {1}'.format(current_light, light_brightness)) lifx.set_brightness(current_light, light_brightness) else: print('Setting {0} color to {1}'.format(current_light, button.name)) lifx.set_color(current_light, 'on', button.name, light_brightness) button.selected = False ``` The rest of the code performs an action based on the button's name by using the `adafruit_lifx` helper module.  When the on/off button is pressed - the code calls `lifx.toggle_light` and passes in the `current_light`. - This button corresponds to the [Toggle Power endpoint defined in the LIFX remote API](https://api.developer.lifx.com/docs/toggle-power). When the brightness button (+ or _-_) is pressed, the code passes the `current_light` and `light_brightness` into `lifx.set_brightness`. Also, the `light_brightness` increments or decrements by 1/4 each time the button is pressed. - This button corresponds to the [Set State endpoint defined in the LIFX remote API](https://api.developer.lifx.com/docs/set-state). If the button's name doesn't correspond to a predefined name, we set the color using the button's name as the color passed into `lifx.set_color`. - This button corresponds to the [Set State endpoint defined in the LIFX remote API](https://api.developer.lifx.com/docs/set-state). - You're not limited by the colors defined in the button\_colors list - you can adjust/mix colors and send those values to the LIFX lights, [check out the colors documentation on their website.](https://api.developer.lifx.com/docs/colors) Finally, the code sets its selected property to false, returning it to its original color to indicate an action has been performed. ## Going further! This guide has only scratched the surface of the LIFX Light Remote HTTP API. There are lots more endpoints, options, and effects to play around with. If you are interested in seeing how this works (in a deeper level) - take a look at the **adafruit\_lifx.py** file [located in the helper library's repository](https://github.com/adafruit/Adafruit_CircuitPython_LIFX). It might be helpful to keep [the LIFX API website](https://api.developer.lifx.com/docs) open in another tab, for reference.  If you end up adding a feature to the library - pull requests on the GitHub repository are appreciated! - If you are not sure how to create a pull request, [Kattni has a fantastic guide about contributing to CircuitPython using GitHub](https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github/create-your-pull-request). ## 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,... In Stock [Buy Now](https://www.adafruit.com/product/4116) [Related Guides to the Product](https://learn.adafruit.com/products/4116/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 In Stock [Buy Now](https://www.adafruit.com/product/592) [Related Guides to the Product](https://learn.adafruit.com/products/592/guides) ### AdaBox011 - PyPortal [AdaBox011 - PyPortal](https://www.adafruit.com/product/4061) Reach out beyond your desk - to the stars and beyond - with **PyPortal**! This ADABOX features a new, easy-to-use IoT device that allows you to customize and create your very own "Internet of Things" portal. We take CircuitPython to the max, pairing a SAMD51 chip with a... No Longer Stocked [Buy Now](https://www.adafruit.com/product/4061) [Related Guides to the Product](https://learn.adafruit.com/products/4061/guides) ## Related Guides - [Adafruit PyPortal - IoT for CircuitPython](https://learn.adafruit.com/adafruit-pyportal.md) - [PyPortal Roku Remote](https://learn.adafruit.com/pyportal-roku-remote.md) - [Welcome to CircuitPython!](https://learn.adafruit.com/welcome-to-circuitpython.md) - [Data Logging IoT Weight Scale](https://learn.adafruit.com/data-logging-iot-weight-scale.md) - [PyPortal IoT Data Logger with Analog Devices ADT7410, Adafruit IO and CircuitPython](https://learn.adafruit.com/iot-pyportal-data-logger-adafruitio-circuitpython.md) - [EZ Make Oven](https://learn.adafruit.com/ez-make-oven.md) - [PyPortal Twitter Follows Trophy](https://learn.adafruit.com/pyportal-twitter-follows-trophy.md) - [Getting Started with Braille Output for CircuitPython REPL](https://learn.adafruit.com/getting-started-braille-output-circuitpython-repl.md) - [Saving CircuitPython Bitmaps and Screenshots](https://learn.adafruit.com/saving-bitmap-screenshots-in-circuitpython.md) - [PyPortal Discord Online Counter](https://learn.adafruit.com/pyportal-discord-online-count.md) - [PyPortal Wall Mount](https://learn.adafruit.com/pyportal-wall-mount.md) - [PyPortal Winamp MP3 Player](https://learn.adafruit.com/pyportal-winamp-mp3-player.md) - [PyPortal Tides Viewer](https://learn.adafruit.com/pyportal-tides-viewer.md) - [PyPortal Smart Thermometer with Analog Devices ADT7410, Adafruit IO and CircuitPython](https://learn.adafruit.com/pyportal-smart-thermometer-with-analog-devices-adt7410-adafruit-io-and-circuitpython.md) - [League of Legends Level Trophy for PyPortal](https://learn.adafruit.com/league-of-legends-level-trophy-for-pyportal.md)