# PyPortal Philips Hue Lighting Controller ## Overview ![](https://cdn-learn.adafruit.com/assets/assets/000/074/587/medium800thumb/circuitpython_ezgif.com-video-to-gif_%2810%29.jpg?1555602967) _ **Want to create the right atmosphere to match your mood? ** _ The[**Philips Hue**](http://meethue.com) is the most intelligent lighting system on the market. The Hue system is comprised of a bridge which communicates over the Internet and smart lights. There's  **_lots_ of different types of lights** to connect to the Hue Bridge - from bulbs to LED strips. With Hue, **you can set light colors** to transform the mood of a room, **create lighting profiles** for different scenarios, create light profiles to wake up to, and even **control lights outside of your home**. - [You can **browse the entire Philips Hue product line on their website here**](https://www2.meethue.com/en-us/products). **In this guide, you'll be building a touchscreen lighting controller with an Adafruit PyPortal to control a light, or groups of lights, connected to a Philips Hue bridge.** ![](https://cdn-learn.adafruit.com/assets/assets/000/074/589/medium800/circuitpython_Untitled.png?1555603518) The  **Philips Hue**  lighting system revolves around the  **Hue Bridge**. This bridge is connected to your router and communicates _wirelessly_ over radio (in a format called ZigBee) to Hue lights and devices linked to the bridge. Instead of including a separate WiFi radio in each bulb, which increases the number of WiFi devices on your router, _only the hub is connected to your router_.  ![circuitpython_046677458485-IMS-en_US.jpeg](https://cdn-learn.adafruit.com/assets/assets/000/074/477/medium640/circuitpython_046677458485-IMS-en_US.jpeg?1555340273) If you're looking for a way to **interactively control Philips Hue Lights with CircuitPython** , 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 [Philips Hue helper module for CircuitPython](https://github.com/adafruit/Adafruit_CircuitPython_Hue/) to make interfacing with Hue incredibly easy.  ![circuitpython_Mu_1_0_2_-_untitled__.png](https://cdn-learn.adafruit.com/assets/assets/000/074/479/medium640/circuitpython_Mu_1_0_2_-_untitled__.png?1555340512) 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.  ## 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) ![circuitpython_internet_of_things___iot_3d_printing_hero_(1).jpg](https://cdn-learn.adafruit.com/assets/assets/000/074/388/medium640/circuitpython_internet_of_things___iot_3d_printing_hero_%281%29.jpg?1555089087) ## 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) - [PyPortal Introduction Guide](https://learn.adafruit.com/adafruit-pyportal) ## 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 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) ### 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 Philips Hue 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 Philips Hue 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 Philips Hue 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 Philips Hue Lighting Controller ## Hue Bridge Setup ## 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\_Philips\_Hue\_Controller**. Copy the contents of the **PyPortal\_Philips\_Hue\_Controller** directory to your PyPortal **CIRCUITPY**  drive. Your CircuitPython code file needs to be named **code.py** to run on startup. https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_Philips_Hue_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_Philips_Hue_Controller.png ) Make sure your board's **lib** folder has the following files and folders copied over. - **adafruit\_hue** - **simpleio** - **adafruit\_bitmap\_font** - **adafruit\_bus\_device** - **adafruit\_button** - **adafruit\_display\_shapes** - **adafruit\_display\_text** - **adafruit\_esp32spi** - **adafruit\_touchscreen** - **neopixel** ## Bridge Setup The Hue system is built around the Hue Bridge. To communicate with the bridge, **you'll need to register a unique username (stored on the bridge) for the PyPortal**. you'll also need the Bridge's IP address to communicate with it. **We've built [the CircuitPython Hue library](https://github.com/adafruit/Adafruit_CircuitPython_Hue) to automate the process of discovering and registering a username with the bridge** - but, you'll still need to add these values to the **settings.toml** file. **This is a one-time setup and does not need to be repeated**. This guide requires you to edit and interact with CircuitPython code.  **Mu** is a simple code editor that works with the Adafruit CircuitPython boards. It's written in Python and works on Windows, MacOS, Linux and Raspberry Pi. The serial console is built right in so you get immediate feedback from your board's serial output! Before proceeding, click the button below to install the Mu Editor. There are versions for PC, mac, and Linux. [Install Mu](https://learn.adafruit.com/welcome-to-circuitpython/installing-mu-editor) First, if you have not already done so, set up a  **settings.toml** file with your local WiFi information, as described in this guide [here](https://learn.adafruit.com/pyportal-philips-hue-lighting-controller/create-your-settings-toml-file). Next, open the Mu editor and open the file **code.py**. For this next step, you will need to connect to the serial console using [Mu](https://learn.adafruit.com/welcome-to-circuitpython/installing-mu-editor) or a different terminal program. - Not sure how to connect to your PyPortal's REPL? [Read this page here and come back to the guide once you're connected.](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) Once connected to the PyPortal, the REPL will display that the code is searching for the bridge address using the WiFi credentials entered previously into **settings.toml** : ```auto code.py output: Finding bridge address... ``` If the bridge address was found, the code will attempt to register a random, unique username with the bridge: ```auto Attempting to register username, press the link button on your Hue Bridge now! ``` When it prints this, you have exactly ** 120 seconds**  to  **press the link button on top of the Hue Bridge**. - We've found that **you may need to press this button more than once** during this period to ensure a username is successfully generated. ![circuitpython_Pasted_Image_4_12_19__3_49_PM.png](https://cdn-learn.adafruit.com/assets/assets/000/074/406/medium640/circuitpython_Pasted_Image_4_12_19__3_49_PM.png?1555098664) Once the button on top of the bridge is pressed, the code will print the bridge IP address and username to the REPL. Modify the **settings.toml** file by adding `BRIDGE_IP` and `HUE_USERNAME` and **save the file**. Your **settings.toml** file should look similar to the sample below: ```auto CIRCUITPY_WIFI_SSID = "your_wifi_ssid" CIRCUITPY_WIFI_PASSWORD = "your_wifi_password" BRIDGE_IP = "192.160.0.00" HUE_USERNAME = "UpsdCULBXvOtWXaqgeTpdAp26Np9hu43x5XjkaLX" ``` ## Issues? ###
Light Setup** **The number next to the light is the light identifier.** You'll be using this value in the code to refer to the light which you're setting. - **Tapping** the _i _next to the light's name will bring up more information about it - like which room/group it's assigned to and the full name. ![circuitpython_light_list.png](https://cdn-learn.adafruit.com/assets/assets/000/074/481/medium640/circuitpython_light_list.png?1555342042) ![circuitpython_light_3.png](https://cdn-learn.adafruit.com/assets/assets/000/074/482/medium640/circuitpython_light_3.png?1555342152) Next, you'll **modify the following lines of code to correspond with the light identifier you're controlling.** - **If you're new to creating and editing CircuitPython code: [Read through this page and come back to this guide when you're ready.](https://learn.adafruit.com/welcome-to-circuitpython/creating-and-editing-code)** For example, if you are setting up a lamp an identifier of 3 and a living room light with an identifier of 1, edit the following line in **code.py** from: `hue_lights={'lamp': 1, 'livingroom': 2}` to `hue_lights={'lamp': 3, 'livingroom': 1}` ## 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. ![circuitpython_internet_of_things___iot_IMG_7651.jpg](https://cdn-learn.adafruit.com/assets/assets/000/074/483/medium640/circuitpython_internet_of_things___iot_IMG_7651.jpg?1555344065) **Select a light by tapping the name of the light you'd like to control.**  The code will default to the first light specified within the `hue_lights` list. ![circuitpython_internet_of_things___iot_ezgif.com-video-to-gif_(6).gif](https://cdn-learn.adafruit.com/assets/assets/000/074/484/medium640thumb/circuitpython_internet_of_things___iot_ezgif.com-video-to-gif_%286%29.jpg?1555344117) **Tap the on/off button ** to toggle the power of the light you selected.  - **Buttons invert their color while they make a request** to the Hue Bridge. **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. ![circuitpython_ezgif.com-video-to-gif_(8).gif](https://cdn-learn.adafruit.com/assets/assets/000/074/583/medium640thumb/circuitpython_ezgif.com-video-to-gif_%288%29.jpg?1555602093) ## Diagnosing Errors **Tapping a color button will set the light to the button's fill color.** - We used the Hue library's `rgb_to_hsv` method to set different colors for the buttons. For more information about this method and how the code works, navigate to the _Code Walkthrough_ page for this guide. ![](https://cdn-learn.adafruit.com/assets/assets/000/074/584/medium800thumb/circuitpython_ezgif.com-video-to-gif_%289%29.jpg?1555602279) # PyPortal Philips Hue Lighting Controller ## Code Walkthrough ## Importing Libraries  ```auto 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 Philips Hue Bridge from adafruit_hue import Bridge ``` The code first imports all of the libraries required to run the Smart Lighting Controller.  **Note** that the code imports a special `adafruit_hue` library. To communicate with the Hue Bridge, we wrote a [CircuitPython helper module called `CircuitPython_Hue`](https://github.com/adafruit/Adafruit_CircuitPython_Hue). This module makes HTTP requests ( or, "talks") to the Hue Bridge's IP address 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 # Get WiFi details, ensure these are setup in settings.toml ssid = getenv("CIRCUITPY_WIFI_SSID") password = getenv("CIRCUITPY_WIFI_PASSWORD") if None in [ssid, password]: raise RuntimeError( "WiFi settings are kept in settings.toml, " "please add them there. The settings file must contain " "'CIRCUITPY_WIFI_SSID', 'CIRCUITPY_WIFI_PASSWORD', " "at a minimum." ) # 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) ``` The next chunk of code grabs information from a **settings.toml** file including wifi configuration. 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 bridge. ## Configuring the Hue helper module ```auto # Attempt to load bridge username and IP address from settings.toml try: username = getenv("HUE_USERNAME") bridge_ip = getenv("BRIDGE_IP") my_bridge = Bridge(wifi, bridge_ip, username) except: # Perform first-time bridge setup my_bridge = Bridge(wifi) print('Finding bridge address...') ip = my_bridge.discover_bridge() print('Attempting to register username, press the link button on your Hue Bridge now!') username = my_bridge.register_username() print(f'ADD THESE VALUES TO settings.toml: \ \nBRIDGE_IP = "{ip}" \ \nHUE_USERNAME = "{username}"') raise ``` The entire Hue system is built around the Hue Bridge. To communicate with the bridge, you'll need to register a unique username (stored on the bridge) for the PyPortal. you'll also need the Bridge's IP address to communicate with it. There's a bit of a HTTP request/reply "dance" associated with this process and it's tricky. The CircuitPython Hue library automates the process of discovering and registering a username with the bridge - but, you'll still need to add these values to the **settings.toml** file.  - For more information about the bridge setup - [read the _Hue Bridge Setup_ page of this guide](https://learn.adafruit.com/pyportal-philips-hue-lighting-controller/hue-bridge-setup). ## Hue Color Setup ```auto print('loading colors...') # color conversions (RGB to Philips Hue-compatible HSB) red = my_bridge.rgb_to_hsb([255, 0, 0]) white = my_bridge.rgb_to_hsb([255, 255, 255]) orange = my_bridge.rgb_to_hsb([255, 165, 0]) yellow = my_bridge.rgb_to_hsb([255, 255, 0]) green = my_bridge.rgb_to_hsb([0, 255, 0]) blue = my_bridge.rgb_to_hsb([0, 0, 255]) purple = my_bridge.rgb_to_hsb([128, 0, 128]) pink = my_bridge.rgb_to_hsb([255, 192, 203]) hue_hsb = {'red': red, 'white': white, 'orange': orange, 'yellow': yellow, 'green': green, 'blue': blue, 'purple': purple, 'pink': pink} ``` When you want to modify the light's state from within your code, you'd use the `set_light` method in `CircuitPython_Hue`. This method mirrors Philips' [_set light state_ API endpoint](https://developers.meethue.com/develop/hue-api/lights-api/#set-light-state) - but it has some non user-friendly features. The **Hue API uses HSB** ( **H** ue, **S** aturation, **B** rightness) instead of **RGB** ( **r** ed, **g** reen, **b** lue) values. It also does not take in brightness percentages, or hue degrees. Instead, it takes in scaled integer values which directly relate to to the brightness percentage or hue degrees.  To make this simpler - we added a **`rgb_to_hsb`** method within the Hue helper module. Passing a list of RGB values into this method will return a scaled HSB list. - **If you wish to use RGB colors with your PyPortal Hue Controller - use this method before calling** `set_light` to convert and scale your colors **.** Our code predefines a few colors (red, white, orange, yellow, green, blue, purple, pink) by converting them _from_ RGB values _to_ scaled HSB values. using `rgb_to_hsb`. ## Button Setup ```python # 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 ```auto # button fill colors button_colors = {'red':0xFF0000, 'white':0xFFFFFF, 'orange':0xFF9900, 'yellow':0xFFFF00, 'green':0x00FF00, 'blue':0x0000FF, 'purple':0x9900FF, 'pink': 0xFF00FF} # 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':'room', 'pos':(195, 15), 'label':'room'}, {'name':'lamp', 'pos':(255, 15), 'label':'lamp'} ] # 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=55, 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. ## Light Setup ```auto # Hue Light/Group Identifiers hue_lights={'lamp': 1, 'livingroom': 2} hue_selector = hue_lights['lamp'] # Default to 25% brightness current_brightness = 25 ``` The code sets up hue light identifiers in `hue_lights` and automatically selects the lamp identifier in the list. This prevents sending the bridge a None type if a button is pressed and no light is selected. It also sets a brightness default of 25%.  - For more information about setting up light identifiers, read the _Hue Lights Setup_ section of this guide. - **To enumerate all the lights connected to the bridge** , you can run the following line from your code: `my_lights = my_bridge.get_lights` and print the JSON response from the hue bridge: `my_lights`.  ## Main Loop ```auto 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 set to `True` - inverting the button's color until the action is fully performed (i.e: the light is changed, toggled, etc). By doing this, you are creating a visual status indicator.  ```auto if button.name == 'living': hue_selector = hue_lights['livingroom'] print('Switching to ', hue_selector) elif button.name == 'room': hue_selector = hue_lights['lamp'] print('Switching to ', hue_selector) ``` Then, the code checks the button's name against its function (what it does). If the button's name is lamp or room, `hue_selector` is toggled to the value of the button. Whenever the code in the main loop sends data to the bridge to modify a light, it uses `hue_selector`  to indicate the light being modified. ```auto elif button.name == 'onoff': print('Toggling {0}...'.format(hue_selector)) my_bridge.toggle_light(int(hue_selector)) ``` If the on/off button is tapped, the code will toggle the state of the selected light. - The Hue Light API does _not_ support toggling light state - we added a `toggle_light` method into the `CircuitPython_Hue` library to get the current state of the light , toggle it, and call `set_light` with the toggled state of the light.. ```auto elif button.name == 'up': current_brightness += 25 print('Setting {0} brightness to {1}'.format(hue_selector, current_brightness)) my_bridge.set_light(int(hue_selector), bri=current_brightness) elif button.name == 'down': current_brightness -= 25 print('Setting {0} brightness to {1}'.format(hue_selector, current_brightness)) my_bridge.set_light(int(hue_selector), bri=current_brightness) ``` When either of the brightness buttons are pressed, they'll modify the value of `current_brightness` by +/-25% and send that value to the bridge using `set_light`. ```auto else: print('Setting {0} color to {1}'.format(hue_selector, button.name)) my_bridge.set_light(light_id=int(hue_selector), hue=int(hue_hsb[button.name][0]), sat=int(hue_hsb[button.name][1]), bri=int(hue_hsb[button.name][2])) button.selected = False ``` If any of the color buttons are pressed, the color's hue, saturation, and brightness values are individually passed into `set_light` along with the light (`hue_selector`). Since the code is finished processing the action, the button's fill is set to its original color by de-selecting the button (`button.selected = False`).  ## Going further! This guide has only scratched the surface of the Philips Hue API! We've detailed out a good amount of the API actions within the [Adafruit\_CircuitPython\_Hue](https://github.com/adafruit/Adafruit_CircuitPython_Hue) library, like discovering new bulbs or setting a scene. If you didn't see the API action you were looking for, feel free to add it to the library. You may find it useful to read through the library and the API reference in different tabs, and cross-referencing them ([Docs are here, you'll need to create an account](https://developers.meethue.com/develop/)) 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,... Out of Stock [Buy Now](https://www.adafruit.com/product/4116) [Related Guides to the Product](https://learn.adafruit.com/products/4116/guides) ### USB A/Micro Cable - 2m [USB A/Micro Cable - 2m](https://www.adafruit.com/product/2185) This is your standard USB A-Plug to Micro-USB cable. It's 2 meters long so you'll have plenty of cord to work with for those longer extensions. In Stock [Buy Now](https://www.adafruit.com/product/2185) [Related Guides to the Product](https://learn.adafruit.com/products/2185/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) ### 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) - [EZ Make Oven](https://learn.adafruit.com/ez-make-oven.md) - [Using LittlevGL with Adafruit Displays](https://learn.adafruit.com/using-littlevgl-with-adafruit-displays.md) - [Program in Logo on an Apple II](https://learn.adafruit.com/program-logo-on-an-apple-ii.md) - [PyPortal Air Quality Display](https://learn.adafruit.com/pyportal-air-quality-display.md) - [PyPortal YouTube Views and Subscribers Display](https://learn.adafruit.com/pyportal-youtube-views-and-subscribers-display.md) - [PyPaint Drawing Program In CircuitPython](https://learn.adafruit.com/pypaint.md) - [PyPortal IoT Plant Monitor with Microsoft Azure IoT and CircuitPython](https://learn.adafruit.com/using-microsoft-azure-iot-with-circuitpython.md) - [PyPortal Wake-Up Light Alarm Clock](https://learn.adafruit.com/pyportal-wake-up-light.md) - [PyPortal Tides Viewer](https://learn.adafruit.com/pyportal-tides-viewer.md) - [Melting Picture Frame for PyPortal IoT images](https://learn.adafruit.com/pyportal-art-display.md) - [Adafruit IO Basics: AirLift](https://learn.adafruit.com/adafruit-io-basics-airlift.md) - [Saving CircuitPython Bitmaps and Screenshots](https://learn.adafruit.com/saving-bitmap-screenshots-in-circuitpython.md) - [Pathfinder Robot Companion](https://learn.adafruit.com/pathfinder.md) - [PyPortal Oblique Strategies](https://learn.adafruit.com/pyportal-oblique-strategies.md) - [CircuitPython Turtle Graphics](https://learn.adafruit.com/circuitpython-turtle-graphics.md)