pyControl4
An asynchronous library to interact with Control4 systems through their built-in REST API. This is known to work on controllers with OS 2.10.1.544795-res and OS 3.0+.
Auto-generated function documentation can be found at https://lawtancool.github.io/pyControl4
For those who are looking for a pre-built solution for controlling their devices, this library is implemented in the official Home Assistant Control4 integration.
Usage example
from pyControl4.account import C4Account
from pyControl4.director import C4Director
from pyControl4.light import C4Light
import asyncio
username = ""
password = ""
ip = "192.168.1.25"
"""Authenticate with Control4 account"""
account = C4Account(username, password)
asyncio.run(account.get_account_bearer_token())
"""Get and print controller name"""
account_controllers = asyncio.run(account.get_account_controllers())
print(account_controllers["controllerCommonName"])
"""Get bearer token to communicate with controller locally"""
director_bearer_token = asyncio.run(
account.get_director_bearer_token(account_controllers["controllerCommonName"])
)["token"]
"""Create new C4Director instance"""
director = C4Director(ip, director_bearer_token)
"""Print all devices on the controller"""
print(asyncio.run(director.get_all_item_info()))
"""Create new C4Light instance"""
light = C4Light(director, 253)
"""Ramp light level to 10% over 10000ms"""
asyncio.run(light.ramp_to_level(10, 10000))
"""Print state of light"""
print(asyncio.run(light.get_state()))
Contributing
Pull requests are welcome! Please lint your Python code with flake8 and format it with Black.
Disclaimer
This library is not affiliated with or endorsed by Control4.
1 maintainer
Metadata
1 maintainer
Release files for pyControl4 2.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pycontrol4-2.0.2.tar.gz | 25.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pycontrol4-2.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.3 kB
Release files / pycontrol4-2.0.2.tar.gz
| Download URL | pycontrol4-2.0.2.tar.gz |
|---|---|
| Size | 25.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
49138f89ad61f7740127f50c3d1669d1fb399e54e7c7cc1971555d17cb7a86ac
|
|
BLAKE2b-256 checksum How to use checksums |
c9086ad7614f02d4cefadc0d73d1df28d0b308e5a62aad249dfb2266458b38ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / pycontrol4-2.0.2-py3-none-any.whl
| Download URL | pycontrol4-2.0.2-py3-none-any.whl |
|---|---|
| Size | 30.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5749b7637643559797d3765d43f7b807cc2f93369c1cab923da619f3b69c2d27
|
|
BLAKE2b-256 checksum How to use checksums |
1a6c31f5911918425db2c38e0ce9cdc2737d2a9e81f1368080ed765680fee289
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
