Asyncio Python library for connecting to and controlling the Logitech Harmony
Project description
Python library for programmatically using a Logitech Harmony Link or Ultimate Hub.
This library originated from iandday/pyharmony which was a fork of bkanuka/pyharmony with the intent to:
Make the harmony library asyncio
Ability to provide one’s own custom callbacks to be called
Automatic reconnect, even if re-connection cannot be established for a time
More easily get the HUB configuration through API call
Additional callbacks: connect, disconnect, HUB configuration updated
Using unique msgid’s ensuring that responses from the HUB are correctly managed.
Protocol
As the harmony protocol is being worked out, notes will be in PROTOCOL.md. Currently it is using web sockets due to a change by Logitech. Logitech has informed they will re-open XMPP sometime in January/2019. Once re-opened this library will be moved to use XMPP.
Status
Retrieving current activity
Querying for entire device information
Querying for activity information only
Querying for current activity
Starting Activity
Sending Command
Changing channels
Custom callbacks.
Usage
aioharmony - Harmony device control
usage: aioharmony [-h] (--harmony_ip HARMONY_IP | --discover)
[--harmony_port HARMONY_PORT]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[--show_responses | --no-show_responses] [--wait WAIT]
{show_config,show_detailed_config,show_current_activity,start_activity,power_off,sync,listen,send_command,change_channel}
...
aioharmony - Harmony device control
positional arguments:
{show_config,show_detailed_config,show_current_activity,start_activity,power_off,sync,listen,send_command,change_channel}
show_config Print the Harmony device configuration.
show_detailed_config
Print the detailed Harmony device configuration.
show_current_activity
Print the current activity config.
start_activity Switch to a different activity.
power_off Stop the activity.
sync Sync the harmony.
listen Output everything HUB sends out
send_command Send a simple command.
change_channel Change the channel
optional arguments:
-h, --help show this help message and exit
--harmony_ip HARMONY_IP
IP Address of the Harmony device. (default: None)
--discover Scan for Harmony devices. (default: False)
--harmony_port HARMONY_PORT
Network port that the Harmony is listening on.
(default: 5222)
--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}
Logging level for all components to print to the
console. (default: INFO)
--show_responses Print out responses coming from HUB. (default: False)
--no-show_responses Do not print responses coming from HUB. (default:
False)
--wait WAIT How long to wait in seconds after completion, useful
in combination with --show-responses. Use -1 to wait
infinite, otherwise has to be a positive number.
(default: 0)
Release Notes
0.1.0. Initial Release
- 0.1.2. Fixed:
Enable callback connect only once initial connect and initialization is completed.
Fix exception when activity/device name/id is None when trying to retrieve name/id.
Fixed content type and name of README in setup.py
- 0.1.3. Fixed:
Retry connect on reconnect
- 0.1.4. Fixed:
Exception when retrieve_hub_info failed to retrieve information
call_callback helper would never return True on success.
Retry connect on reconnect (was not awaited upon)
TODO
Redo discovery for asyncio. This will be done once XMPP is re-implemented by Logitech
More items can be done from the Harmony iOS app; determining what could be done within the library as well
Is it possible to update device configuration?
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
Built Distribution
Hashes for aioharmony-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebd47c93708707ecaf129a2cc820377c09aa5d5b8b5084e108e138fb3db5d38f |
|
MD5 | 5a32d4ee0febc8fa971f4b556ab72fcd |
|
BLAKE2b-256 | cfeda2b957c5444aad0c745cc7b8dbb6158a8c10b006847833ea8fbb97c963fc |