Skip to main content

Python 3 asyncio package for interacting with Control4 systems

Project description

pyControl4

pdocPyPI ReleasePyPI version

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.3.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

pyControl4-0.0.3-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file pyControl4-0.0.3.tar.gz.

File metadata

  • Download URL: pyControl4-0.0.3.tar.gz
  • Upload date:
  • Size: 6.8 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.47.0 CPython/3.8.3

File hashes

Hashes for pyControl4-0.0.3.tar.gz
Algorithm Hash digest
SHA256 e08edceecd33c9c5678bf223155a0a21d260c9ae57402f3c25d4574c243e8684
MD5 ac65260e37253d313fd360a1affb086d
BLAKE2b-256 35c6ac9bd2712cf0f33dac627c0560b8cf0489288cd581b10afb9d00b817733b

See more details on using hashes here.

Provenance

File details

Details for the file pyControl4-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyControl4-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.47.0 CPython/3.8.3

File hashes

Hashes for pyControl4-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed62e0e92e6a56bfec1bbd840b0249b70e15661b5f80c775b281d87956aa690c
MD5 0c247d2d1ea775a0927023700935e34b
BLAKE2b-256 c849ffdcb60e0ad04870286a1e86aa6ee8d27ea87f112defc2a1c4b15edb10f0

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