Skip to main content

Python 3 asyncio package for interacting with Control4 systems

Project description

pyControl4

pdocPyPI 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)

"""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"])
)

"""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.2.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

pyControl4-0.0.2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyControl4-0.0.2.tar.gz
  • Upload date:
  • Size: 5.0 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.2.tar.gz
Algorithm Hash digest
SHA256 0ee0fa7d7c5eb737fe6923cf549cc294eb64a3f1ec603ee363342e8bfa988f80
MD5 b86c391798d6dcb0c5198ceb5c579a8c
BLAKE2b-256 340e6b61cfb3771501e614ef9a80feded64690b43d915725960b778d9eb0db34

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyControl4-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 10.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ccf379a38be2c71049021d29f084fa439c29e636b547c8ee3105aaef930c7a8c
MD5 fd9fba94f1a9bf0bfdfd38148e3a5b8d
BLAKE2b-256 6b0325700916418a5a76c54a9791bcc2bbb8715d9767401a67284f73c0faa825

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