Skip to main content

Forked Python 3 asyncio package for interacting with Control4 systems and includes room support

Project description

pyControl4

Note: This is a fork of the original pycontrol4 library. This version is a forked version that supports room manipulation

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+.

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
import json

username = ""
password = ""

ip = "192.168.1.25"

"""Authenticate with Control4 account"""
account = C4Account(username, password)
asyncio.run(account.getAccountBearerToken())

"""Get and print controller name"""
accountControllers = asyncio.run(account.getAccountControllers())
print(accountControllers["controllerCommonName"])

"""Get bearer token to communicate with controller locally"""
director_bearer_token = asyncio.run(
    account.getDirectorBearerToken(accountControllers["controllerCommonName"])
)["token"]

"""Create new C4Director instance"""
director = C4Director(ip, director_bearer_token)

"""Print all devices on the controller"""
print(asyncio.run(director.getAllItemInfo()))

"""Create new C4Light instance"""
light = C4Light(director, 253)

"""Ramp light level to 10% over 10000ms"""
asyncio.run(light.rampToLevel(10, 10000))

"""Print state of light"""
print(asyncio.run(light.getState()))

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyC4Room-1.0.0.tar.gz (52.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyC4Room-1.0.0-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file pyC4Room-1.0.0.tar.gz.

File metadata

  • Download URL: pyC4Room-1.0.0.tar.gz
  • Upload date:
  • Size: 52.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for pyC4Room-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1337ed09b13f598ee275a9aedfabec991d254b8714e093f986cb7fa61b859a0e
MD5 7c9ee9fb14fbfdc215fe8ff7589bf64b
BLAKE2b-256 5cadfb56db497b9d395414d26cc4e7ade0c3bb417415ddbe308987145f7ec6d5

See more details on using hashes here.

File details

Details for the file pyC4Room-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyC4Room-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 47.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for pyC4Room-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 daf61cfe7b0c68cd5d385295191ec86faf7d3297abade4f6e1cee55d20ce491c
MD5 0644b58ed7013ad146ce3b386e8083d0
BLAKE2b-256 0cc049ba1f204f0c8b1f2590e93eabc05824f2221654006a0fc4675d00f0ad7a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page