Skip to main content

Async Python client for the Homecast REST API

Project description

pyhomecast

Async Python client for the Homecast REST API.

Installation

pip install pyhomecast

Usage

import aiohttp
from pyhomecast import HomecastClient

async with aiohttp.ClientSession() as session:
    client = HomecastClient(session)
    client.authenticate("your_access_token")

    # Get all device state
    state = await client.get_state()
    for device in state.devices.values():
        print(f"{device.name} ({device.device_type}): {device.state}")

    # Control a device
    await client.set_state({
        "my_home_0bf8": {
            "living_room_a1b2": {
                "ceiling_light_c3d4": {"on": True, "brightness": 80}
            }
        }
    })

    # Run a scene
    await client.run_scene("my_home_0bf8", "Good Morning")

API

HomecastClient(session, api_url="https://api.homecast.cloud")

  • authenticate(token) - Set the Bearer token
  • get_state(home?, room?, device_type?, name?) - Fetch device state (returns HomecastState)
  • set_state(updates) - Control devices
  • run_scene(home, name) - Execute a scene

Models

  • HomecastState - Contains devices and homes dicts
  • HomecastDevice - Single device with state, settable, device_type
  • HomecastHome - Home with key and name

Exceptions

  • HomecastError - Base exception
  • HomecastAuthError - 401/403 errors
  • HomecastConnectionError - Network/server errors

License

MIT

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

pyhomecast-0.1.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhomecast-0.1.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file pyhomecast-0.1.0.tar.gz.

File metadata

  • Download URL: pyhomecast-0.1.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyhomecast-0.1.0.tar.gz
Algorithm Hash digest
SHA256 63c1dde29314ce48c55b5a7ca9d2636024707c56460ae7b0c09d8b721272dc2e
MD5 4c5ea07bcc2d219d6ec358c2242b715d
BLAKE2b-256 5c87c1bd447a084c89264e64a74ea8de8daa0dd93750b5f3966b8a535b5b1504

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhomecast-0.1.0.tar.gz:

Publisher: python-package.yml on parob/pyhomecast

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyhomecast-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyhomecast-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyhomecast-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 004cc51e404b5ecec703c6b5639c8d42a6d2c24ae863117587bf07e77d157b0c
MD5 3a3f070c415bb34b6152e24f0c1bfdd9
BLAKE2b-256 ea8bf125a01dce1481cb5570fea67299e4d60ef9557d89eeb68998777896bbf0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhomecast-0.1.0-py3-none-any.whl:

Publisher: python-package.yml on parob/pyhomecast

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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