用于通过heos cli协议控制heos设备的异步python库
pyheos的Python项目详细描述
皮霍斯
一个异步python库,用于通过heos cli协议控制heos设备(固件为1.505.140或更新版本的播放器为1.14版)。
安装
pip install pyheos
或
pip install --use-wheel pyheos
开始
Heos
类是通过单个网络连接向本地网络上所有与HEOS兼容的设备提供控制的实现建议连接到硬接线设备。
pyheos.Heos(host, *, timeout, heart_beat, all_progress_events, dispatcher)
host: str
:本地网络上HEOS设备的IP地址或主机名此参数是必需的timeout: float
:连接和发出命令期间等待的秒数。默认值是pyheos.const.DEFAULT_TIMEOUT = 5.0
。此参数是必需的。heart_beat: Optional[float]
:自上次发出心跳命令的活动后的秒数。默认值是pyheos.const.DEFAULT_HEART_BEAT = 60.0
将此参数设置为None
可禁用心跳。all_progress_events
:设置为True
以接收每个媒体播放进度的信号,或设置为False
仅在媒体状态转换为播放或更改时接收信号。默认值是True
。此参数是必需的。dispatcher: Optional[pyheos.Dispatcher]
:用于发出信号的调度器实例。默认值是None
,这将导致使用默认的分派器实现。
pyheos.Heos.connect(*, auto_reconnect, reconnect_delay)
连接到指定的主机。这种方法是一种协同活动
auto_reconnect: bool
:设置为True
以在断开连接时自动重新连接到主机默认值是False
reconnect_delay: float
:在连接失败时尝试重新连接之前等待的秒数。默认值是DEFAULT_RECONNECT_DELAY = 5.0
pyheos.Heos.disconnect()
断开与指定主机的连接。这种方法是一种协同活动。
pyheos.Heos.get_players(*, refresh)
检索可用的播放器作为Dict[int, pyheos.Heos.HeosPlayer]
,其中键表示player_id
,值表示HeosPlayer
实例这种方法是一种协同活动。此方法将填充players
属性,并开始跟踪对播放机的更改。
refresh
:设置为True
,从cli中检索最新的可用播放机。默认为False
,并将返回先前加载的播放器。
示例:
importpyheosheos=Heos('172.16.0.1')awaitheos.connect(auto_reconnect=True)players=awaitheos.get_players()...awaitheos.disconnect()