Skip to main content

Async client for the HiFiBerry OS / HBOS NG AudioControl REST API

Project description

aiohifiberry

Async Python client for the HiFiBerry OS / HBOS NG AudioControl REST API.

This package is intended to hold the device communication layer used by a Home Assistant Core integration. It does not import Home Assistant.

Example

from aiohttp import ClientSession

from aiohifiberry import AudioControlClient


async with ClientSession() as session:
    client = AudioControlClient(session, "hifiberry.local")
    await client.async_update()
    print(client.now_playing)
    await client.async_command("pause")

Supported API Areas

  • Connection validation.
  • Now-playing and player discovery.
  • Active-player capability detection.
  • Play, pause, stop, next, and previous commands.
  • Volume state and volume commands.
  • HBOS NG cover-art lookup.

HBOS NG normally exposes AudioControl through the public web UI route:

http://<device>/api/audiocontrol/

Some builds also expose backend services on custom ports. The client defaults to port 80 and falls back to the public route for proxied endpoints when a non-80 port is supplied.

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

aiohifiberry-0.2.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

aiohifiberry-0.2.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file aiohifiberry-0.2.0.tar.gz.

File metadata

  • Download URL: aiohifiberry-0.2.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for aiohifiberry-0.2.0.tar.gz
Algorithm Hash digest
SHA256 397d7cbe5815753f5090763b1a1e71cffa4e74a7d8ea92f94b996766c9ee128d
MD5 fe0ad0c0a40bb6bd8c58aaa7de95b75a
BLAKE2b-256 609ee0afb3fc02a0f5d7db66ebab0db815db74c9dced133f8dbe3fde35c8a256

See more details on using hashes here.

File details

Details for the file aiohifiberry-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: aiohifiberry-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for aiohifiberry-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e2b8f404a2ff15d754bfd53bb71645297b581d9a4b86afa4605114b9bbb9f82
MD5 16dc7dc02d72f33c54113344f08351ce
BLAKE2b-256 0251dc8fb1eefe835270fe52f4c5dffe85a55c3827a9dfc038e0dba7480add60

See more details on using hashes here.

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