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

Uploaded Source

Built Distribution

pyControl4-0.0.1-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyControl4-0.0.1.tar.gz
  • Upload date:
  • Size: 4.9 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.46.1 CPython/3.8.3

File hashes

Hashes for pyControl4-0.0.1.tar.gz
Algorithm Hash digest
SHA256 8ff5557db0bdd205fa73aff3de51f2156c76c66cb265d71c3b52fa67ae5eca50
MD5 fd0b24c53fa11b74091c56bf05201af1
BLAKE2b-256 014ddba2a52b248cbb4b61695e80a6881fdf575b5b0a5c4a2f1fef1b1bfd5e12

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for pyControl4-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6f45ca7479e69b7919a5e791988dbd316c3a6bd51c18ce35aa3aa73fc31016e0
MD5 d5f75409e535f16974b1b9fa6ff95ed5
BLAKE2b-256 227a69759c4d313ae104150a475a5dbcf7c3b634be64253554b4ef099eda9249

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