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.6a1.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyControl4-0.0.6a1.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.6a1.tar.gz
Algorithm Hash digest
SHA256 152d5e1fcc54c7c4a6c8f2da6c281b4bd514a4a14774180f4565e8f9f8be45d2
MD5 daaf1add16bddc5fa907ca62be52fad7
BLAKE2b-256 5b58649baff0879a808b0b413ae05dcf74368e788e9b265e2f78a2de4e32d092

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyControl4-0.0.6a1-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.6a1-py3-none-any.whl
Algorithm Hash digest
SHA256 56ec18c63f628e1e29409dd8d0a6da90f416c4c8ebb96ff0abbccb3dc90707e7
MD5 94bf5b50c8913fa32f86bccf9f9b236a
BLAKE2b-256 33b86e9a45a582b90c676f19e47d2583a0baef5589ecb330b6cbb51b65f15d7e

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