An async python library for controlling HEOS devices through the HEOS CLI Protocol
Project description
pyheos
An async python library for controlling HEOS devices through the HEOS CLI Protocol (version 1.13 for players with firmware 1.481.130 or newer).
Installation
pip install pyheos
or
pip install --use-wheel pyheos
Getting Started
The Heos
class is the implementation providing control to all HEOS compatible devices on the local network through a single network connection. It is suggested to connect to a device that is hard-wired.
pyheos.Heos(host, *, timeout, heart_beat, all_progress_events, dispatcher)
host: str
: The IP Address or hostname of a HEOS device on the local network. This parameter is required.timeout: float
: Number of seconds to wait during connection and issuing commands. Default ispyheos.const.DEFAULT_TIMEOUT = 5.0
. This parameter is required.heart_beat: Optional[float]
: Number of seconds since last activity to issue a heart-beat command. Default ispyheos.const.DEFAULT_HEART_BEAT = 60.0
. Set this parameter toNone
to disable heart-beat.all_progress_events
: Set toTrue
to receive signals for each media play-back progression orFalse
to only receive a signal when media state transitions to playing or changes. Defualt isTrue
. This parameter is required.dispatcher: Optional[pyheos.Dispatcher]
: An instance of dispatcher to use for raising signals. The default isNone
which results in use of he default dispatcher implementation.
pyheos.Heos.connect(*, auto_reconnect, reconnect_delay)
Connect to the specified host. This method is a coroutine.
auto_reconnect: bool
: Set toTrue
to automatically reconnect to the host upon disconnection. The default isFalse
.reconnect_delay: float
: The number of seconds to wait before attempting to reconnect upon a connection failure. The default isDEFAULT_RECONNECT_DELAY = 5.0
pyheos.Heos.disconnect()
Disconnect from the specified host. This method is a coroutine.
Example:
import pyheos
heos = Heos('172.16.0.1')
await heos.connect(auto_reconnect=True)
...
await heos.disconnect()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyheos-0.1.0.tar.gz
(21.3 kB
view hashes)
Built Distribution
pyheos-0.1.0-py3-none-any.whl
(26.7 kB
view hashes)