Skip to content

adafruit/Adafruit_CircuitPython_Wiz

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython helper library for Wiz connected lights.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Works with any CircuitPython device that supports WIFI or Ethernet networking.

Purchase one from the Adafruit shop

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-wiz

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-wiz

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-wiz

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_wiz

Or the following command to update an existing version:

circup update

Usage Example

import wifi

from adafruit_wiz import SCENE_IDS, WizConnectedLight

udp_host = "192.168.1.143"  # IP of UDP Wiz connected light
udp_port = 38899  # Default port is 38899, change if your light is configured differently

my_lamp = WizConnectedLight(udp_host, udp_port, wifi.radio)

print(f"Current Status: {my_lamp.status}")

# set RGB Color
my_lamp.rgb_color = (255, 0, 255)

# set light color temperature
# my_lamp.temperature = 4400

# print available scenes
# print(SCENE_IDS.keys())

# set the scene
# my_lamp.scene = "Party"

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

About

CircuitPython helper library for Wiz connected lights

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages