Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-wiz/badge/?version=latest
:target: https://docs.circuitpython.org/projects/wiz/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Wiz/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Wiz/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython helper library for Wiz connected lights.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Works with any CircuitPython device has built-in WIFI.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-wiz/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-wiz
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-wiz
To install in a virtual environment in your current project:
.. code-block:: shell
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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_wiz
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
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 <https://docs.circuitpython.org/projects/wiz/en/latest/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Wiz/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-wiz",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, wiz, light, lights, led, rgb, smartlight, iot, connected, wizconnected, easyconnect",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/00/e9/e488d47d73a0cca095947ea6ac561dbf1d453c451a51993cb1227cf3fbb4/adafruit_circuitpython_wiz-1.1.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-wiz/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/wiz/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Wiz/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Wiz/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython helper library for Wiz connected lights.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\n\nWorks with any CircuitPython device has built-in WIFI.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-wiz/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-wiz\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-wiz\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install adafruit-circuitpython-wiz\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_wiz\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import wifi\n\n from adafruit_wiz import SCENE_IDS, WizConnectedLight\n\n udp_host = \"192.168.1.143\" # IP of UDP Wiz connected light\n udp_port = 38899 # Default port is 38899, change if your light is configured differently\n\n my_lamp = WizConnectedLight(udp_host, udp_port, wifi.radio)\n\n print(f\"Current Status: {my_lamp.status}\")\n\n # set RGB Color\n my_lamp.rgb_color = (255, 0, 255)\n\n # set light color temperature\n # my_lamp.temperature = 4400\n\n # print available scenes\n # print(SCENE_IDS.keys())\n\n # set the scene\n # my_lamp.scene = \"Party\"\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/wiz/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_Wiz/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for Wiz connected lights",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Wiz"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" wiz",
" light",
" lights",
" led",
" rgb",
" smartlight",
" iot",
" connected",
" wizconnected",
" easyconnect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e2d34c6ccd201822c9e9e0ee8603683deed02b13d8e0a52b543071da33501b8",
"md5": "148d97b7331985cbfa0e51fc8b2e1fd1",
"sha256": "2ca44836fd5b2625e09f79612bbde3ce95ea390cd019be3368d23f06eeac2fe8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_wiz-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "148d97b7331985cbfa0e51fc8b2e1fd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7657,
"upload_time": "2025-01-17T18:41:38",
"upload_time_iso_8601": "2025-01-17T18:41:38.194521Z",
"url": "https://files.pythonhosted.org/packages/8e/2d/34c6ccd201822c9e9e0ee8603683deed02b13d8e0a52b543071da33501b8/adafruit_circuitpython_wiz-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00e9e488d47d73a0cca095947ea6ac561dbf1d453c451a51993cb1227cf3fbb4",
"md5": "438f7bcef9844b64c90c9c0771b5b6cb",
"sha256": "45e13df5b16b1ca3b5d4c5e3161326f7018e89c045c48bc6db88866af4ef7bee"
},
"downloads": -1,
"filename": "adafruit_circuitpython_wiz-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "438f7bcef9844b64c90c9c0771b5b6cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27017,
"upload_time": "2025-01-17T18:41:40",
"upload_time_iso_8601": "2025-01-17T18:41:40.187885Z",
"url": "https://files.pythonhosted.org/packages/00/e9/e488d47d73a0cca095947ea6ac561dbf1d453c451a51993cb1227cf3fbb4/adafruit_circuitpython_wiz-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-17 18:41:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Wiz",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-connectionmanager",
"specs": []
}
],
"lcname": "adafruit-circuitpython-wiz"
}
JSON
