Skip to main content

Python 3 asyncio package for interacting with Control4 systems

Project description

pyControl4

PyPI versionDownloads

CIpdocPyPI Release

An asynchronous library to interact with Control4 systems through their built-in REST API. This is only known to work on controllers with OS 3.0 or newer.

Auto-generated function documentation can be found at https://lawtancool.github.io/pyControl4

Usage example

from pyControl4.auth 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()))

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

pyControl4-0.0.6a2.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

pyControl4-0.0.6a2-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file pyControl4-0.0.6a2.tar.gz.

File metadata

  • Download URL: pyControl4-0.0.6a2.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

File hashes

Hashes for pyControl4-0.0.6a2.tar.gz
Algorithm Hash digest
SHA256 40d32be5696ebc701f53a18cea6aa839f151edbcd7dbf14175de1dd228bf5b9f
MD5 b4b0f2d50b9f7ad3ee5550e16bcc2b93
BLAKE2b-256 71c215dc45f311b7d857a7ce4c11ee72fe1633673874a93f26b29100dcab2cec

See more details on using hashes here.

Provenance

File details

Details for the file pyControl4-0.0.6a2-py3-none-any.whl.

File metadata

  • Download URL: pyControl4-0.0.6a2-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

File hashes

Hashes for pyControl4-0.0.6a2-py3-none-any.whl
Algorithm Hash digest
SHA256 0dcefa21502e3cbeadb143c2309fc9fe5af70c366b18e3eef79f157a07961343
MD5 c1564efd536356297186f8b6b9886295
BLAKE2b-256 140839ce6b5e80d3d70b596ef3e23ac098341fc2a3915a53b7e3adb1b2be2469

See more details on using hashes here.

Provenance

Supported by

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