{ "info": { "author": "Andrew Sayre", "author_email": "andrew@sayre.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Home Automation", "Topic :: Software Development :: Libraries" ], "description": "# pyheos\n[![Build Status](https://travis-ci.org/andrewsayre/pyheos.svg?branch=master)](https://travis-ci.org/andrewsayre/pyheos)\n[![Coverage Status](https://coveralls.io/repos/github/andrewsayre/pyheos/badge.svg?branch=master)](https://coveralls.io/github/andrewsayre/pyheos?branch=master)\n[![image](https://img.shields.io/pypi/v/pyheos.svg)](https://pypi.org/project/pyheos/)\n[![image](https://img.shields.io/pypi/pyversions/pyheos.svg)](https://pypi.org/project/pyheos/)\n[![image](https://img.shields.io/pypi/l/pyheos.svg)](https://pypi.org/project/pyheos/)\n[![image](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)\n\nAn async python library for controlling HEOS devices through the HEOS CLI Protocol (version 1.14 for players with firmware 1.505.140 or newer).\n\n## Installation\n```bash\npip install pyheos\n```\nor\n```bash\npip install --use-wheel pyheos\n```\n\n## Getting Started\n\nThe `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.\n\n#### `pyheos.Heos(host, *, timeout, heart_beat, all_progress_events, dispatcher)`\n- `host: str`: The IP Address or hostname of a HEOS device on the local network. This parameter is required.\n- `timeout: float`: Number of seconds to wait during connection and issuing commands. Default is `pyheos.const.DEFAULT_TIMEOUT = 5.0`. This parameter is required.\n- `heart_beat: Optional[float]`: Number of seconds since last activity to issue a heart-beat command. Default is `pyheos.const.DEFAULT_HEART_BEAT = 60.0`. Set this parameter to `None` to disable heart-beat.\n- `all_progress_events`: Set to `True` to receive signals for each media play-back progression or `False` to only receive a signal when media state transitions to playing or changes. Default is `True`. This parameter is required.\n- `dispatcher: Optional[pyheos.Dispatcher]`: An instance of dispatcher to use for raising signals. The default is `None` which results in use of the default dispatcher implementation.\n\n#### `pyheos.Heos.connect(*, auto_reconnect, reconnect_delay)`\n\nConnect to the specified host. This method is a coroutine.\n- `auto_reconnect: bool`: Set to `True` to automatically reconnect to the host upon disconnection. The default is `False`.\n- `reconnect_delay: float`: The number of seconds to wait before attempting to reconnect upon a connection failure. The default is `DEFAULT_RECONNECT_DELAY = 5.0`\n\n#### `pyheos.Heos.disconnect()`\n\nDisconnect from the specified host. This method is a coroutine.\n\n#### `pyheos.Heos.get_players(*, refresh)`\n\nRetrieve the available players as a `Dict[int, pyheos.Heos.HeosPlayer]` where the key represents the `player_id` and the value the `HeosPlayer` instance. This method is a coroutine. This method will populate the `players` property and will begin tracking changes to the players.\n- `refresh`: Set to `True` to retrieve the latest available players from the CLI. The default is `False` and will return the previous loaded players.\n\n##### Example:\n```python\nimport pyheos\n\nheos = Heos('172.16.0.1')\n\nawait heos.connect(auto_reconnect=True)\nplayers = await heos.get_players()\n...\nawait heos.disconnect()\n```\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/andrewsayre/pyheos", "keywords": "heos", "license": "ASL 2.0", "maintainer": "", "maintainer_email": "", "name": "pyheos", "package_url": "https://pypi.org/project/pyheos/", "platform": "any", "project_url": "https://pypi.org/project/pyheos/", "project_urls": { "Homepage": "https://github.com/andrewsayre/pyheos" }, "release_url": "https://pypi.org/project/pyheos/0.6.0/", "requires_dist": null, "requires_python": "", "summary": "An async python library for controlling HEOS devices through the HEOS CLI Protocol", "version": "0.6.0" }, "last_serial": 5725759, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "c2c73fed220ec36b24535211f886ede5", "sha256": "174b847c76170c4016d81aaedeacd7374284fabf21b1ce503657c8282f7fe7dd" }, "downloads": -1, "filename": "pyheos-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c2c73fed220ec36b24535211f886ede5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 26677, "upload_time": "2019-03-25T04:14:00", "url": "https://files.pythonhosted.org/packages/14/25/57b588d700f47936eeabf02b669384cfbc88dacb9ea611fb8db9235d25ee/pyheos-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ea877c219709d41ce7a0816e14e47f33", "sha256": "b15b9d9b5e3b1b82b4da2782da6e4ac1103eeec2724744e915f5ce7efe22915b" }, "downloads": -1, "filename": "pyheos-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ea877c219709d41ce7a0816e14e47f33", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21299, "upload_time": "2019-03-25T04:14:02", "url": "https://files.pythonhosted.org/packages/bb/25/815a69909daa346a61b9368c5a4c85a51b8cf94c3aa61891ccc69a30503d/pyheos-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "0fb1656f1afd8ee5226caa47fca812dc", "sha256": "74dd0094dfab4cce6e732c958f9ec306696f2fc911aad76304e565bec61676d2" }, "downloads": -1, "filename": "pyheos-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0fb1656f1afd8ee5226caa47fca812dc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 27186, "upload_time": "2019-03-27T03:51:45", "url": "https://files.pythonhosted.org/packages/4a/2a/31ad68c5ced8f361ebb31bb988d7cfa04e9bef5c6b698dacf9da9d22ce7c/pyheos-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e79b17df1913dc02f6e9447a06bead8b", "sha256": "9e954ed223e9c1decd31573beafa9c15a17c7ede6b5651b2ac7133ce13485b64" }, "downloads": -1, "filename": "pyheos-0.2.0.tar.gz", "has_sig": false, "md5_digest": "e79b17df1913dc02f6e9447a06bead8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21898, "upload_time": "2019-03-27T03:51:46", "url": "https://files.pythonhosted.org/packages/a4/28/2c106ffb4cd312cc8e8fc0f38c4a528f161387f5dafa4d6d2a14318b6f38/pyheos-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "0c718e836fcbd024f6e861e5ff29e3c5", "sha256": "361bd001e29418acff3c855acf7b70fc7fba8f1454a6411841c6a672558e369b" }, "downloads": -1, "filename": "pyheos-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0c718e836fcbd024f6e861e5ff29e3c5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 27202, "upload_time": "2019-03-31T04:03:57", "url": "https://files.pythonhosted.org/packages/78/3b/8440279417497b90bf5d13d60863534c7d9a60f0c2d4b4f550fd88ea6bc5/pyheos-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "62228ab026bc06b2d159fa142374f99e", "sha256": "1f930f1170cf4ee5f758fb2f2077a9a0400588423662756e9c8509d538f74d65" }, "downloads": -1, "filename": "pyheos-0.2.1.tar.gz", "has_sig": false, "md5_digest": "62228ab026bc06b2d159fa142374f99e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21919, "upload_time": "2019-03-31T04:03:58", "url": "https://files.pythonhosted.org/packages/fa/45/efb32f3905c25467208af27b104804232abbce0b0d0f1e36465779ce03b9/pyheos-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "0cc6ec73d2334952b0e48407246a832b", "sha256": "235db307cb8152139b99ad453be42b0f89bfaaeb808e9c22668a211a867e74e1" }, "downloads": -1, "filename": "pyheos-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0cc6ec73d2334952b0e48407246a832b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 27757, "upload_time": "2019-03-31T05:48:25", "url": "https://files.pythonhosted.org/packages/cd/df/1769d2e17e9a868f67da6417a34ab6b9d667e28cffb51d0284a91e7ae6eb/pyheos-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "02d1ec5fe2d4d42534bc6897f5107020", "sha256": "e68b80bef5b84c29e1d19851421cbbc5e183e4d3838524282eb7bf676c61bed1" }, "downloads": -1, "filename": "pyheos-0.3.0.tar.gz", "has_sig": false, "md5_digest": "02d1ec5fe2d4d42534bc6897f5107020", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22566, "upload_time": "2019-03-31T05:48:27", "url": "https://files.pythonhosted.org/packages/76/3f/8841d7bddebfec69c0502e93c7ebd773b6caa51b3ba98df72d550e8d1db1/pyheos-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "175350b617f385909900e923f359aa09", "sha256": "9cbdfa0faba29c4f4788deddce7db963872d15bbb922e83502308fda93d009eb" }, "downloads": -1, "filename": "pyheos-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "175350b617f385909900e923f359aa09", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28678, "upload_time": "2019-04-08T19:57:27", "url": "https://files.pythonhosted.org/packages/42/95/dafef04a52a2f65ee039b20b6fb59642c7f6a55f296d0787ec4bb7b4bb37/pyheos-0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "573c249dfc80448abd652a5a72d65236", "sha256": "bcc17feb68b97a1dcffd389f61fbf0f22b49896e893c143b331ff2a1ab6a591f" }, "downloads": -1, "filename": "pyheos-0.3.1.tar.gz", "has_sig": false, "md5_digest": "573c249dfc80448abd652a5a72d65236", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23311, "upload_time": "2019-04-08T19:57:28", "url": "https://files.pythonhosted.org/packages/5e/4b/4bb8fbea66cc4928fcdb3b5fdf7c5876d73d0477cafb952f73c8448f2782/pyheos-0.3.1.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "beb445396f1fac2d1b7ba9321ea73b86", "sha256": "3b026aa0c4bd031df52b48951acb3f05e8b5ed8e603b000b70d3fc3d8bd5df2d" }, "downloads": -1, "filename": "pyheos-0.4.0-py3-none-any.whl", "has_sig": false, "md5_digest": "beb445396f1fac2d1b7ba9321ea73b86", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31135, "upload_time": "2019-04-19T01:00:40", "url": "https://files.pythonhosted.org/packages/4d/23/c39e4066c3cda80c2d742001af0c964e4a4b14d6efbd1557eaee7bcf3e91/pyheos-0.4.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3e9e95b4114328669bc4b752100a8acd", "sha256": "556632f2f136e40ff039b85e9ccbb7cb620d907e1752610cadc2004022719143" }, "downloads": -1, "filename": "pyheos-0.4.0.tar.gz", "has_sig": false, "md5_digest": "3e9e95b4114328669bc4b752100a8acd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25055, "upload_time": "2019-04-19T01:00:41", "url": "https://files.pythonhosted.org/packages/39/91/1fb5d63954d5be21180cae93f73632f9beec6858bc1c5e8a45fcf2de43ff/pyheos-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "f424c55a0b27d3865555c3c7929f27e7", "sha256": "6254093ed6fe318a7ef2726e38611a424de96ad20864a9a02054f7f33d7a57b2" }, "downloads": -1, "filename": "pyheos-0.4.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f424c55a0b27d3865555c3c7929f27e7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31128, "upload_time": "2019-04-25T01:31:42", "url": "https://files.pythonhosted.org/packages/e9/d7/85673b9481e41b9fb2d6f4caf565e65cb5a412fa7736953b93dc618c38c2/pyheos-0.4.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6cf70b2a9b6ae1b1bd13a0c3dd945cd0", "sha256": "744d3605380ef68d0bb7aa116c9114962aab6e9f7340cd7390d46c15b9d3d38e" }, "downloads": -1, "filename": "pyheos-0.4.1.tar.gz", "has_sig": false, "md5_digest": "6cf70b2a9b6ae1b1bd13a0c3dd945cd0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25052, "upload_time": "2019-04-25T01:31:44", "url": "https://files.pythonhosted.org/packages/04/03/7e839de18108240294c4b4fb33986f6897cc252a66d792645c1360eeb7d7/pyheos-0.4.1.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "de256557f08bfdfb9f5781dba8db16e4", "sha256": "43ec2061a3082d483804039cd64f3b444bbfd551e328afe6fdd618668bfd6e2c" }, "downloads": -1, "filename": "pyheos-0.5.0-py3-none-any.whl", "has_sig": false, "md5_digest": "de256557f08bfdfb9f5781dba8db16e4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 36646, "upload_time": "2019-04-28T23:56:56", "url": "https://files.pythonhosted.org/packages/57/aa/69502d48d251169fdb8c914e189ba17dbd62d3522b009e61f6627431f016/pyheos-0.5.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "157cf43c587b251280a5f8089b17e312", "sha256": "4c3bf659a7cdd527afe9375f6a68c4275f59a09c94e97ebcd6f80ad7937848a1" }, "downloads": -1, "filename": "pyheos-0.5.0.tar.gz", "has_sig": false, "md5_digest": "157cf43c587b251280a5f8089b17e312", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27333, "upload_time": "2019-04-28T23:56:59", "url": "https://files.pythonhosted.org/packages/5f/43/718fd9c955105f1ab1e0477ac8bbf91acb779230a45ec3d5ef789c2b81d8/pyheos-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "31aafe7876cc1069f6f88336b099c9d3", "sha256": "b202f732c96a9f42e8f4a8af99092b1478acd9776c6f7484c578e1b3f4e2099a" }, "downloads": -1, "filename": "pyheos-0.5.1-py3-none-any.whl", "has_sig": false, "md5_digest": "31aafe7876cc1069f6f88336b099c9d3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 36702, "upload_time": "2019-05-02T03:06:51", "url": "https://files.pythonhosted.org/packages/86/d9/9e217631a9c931dfb358a75dbfe3a313f316255464b66897bab198b6ac84/pyheos-0.5.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dffdbce37d4b014f616a32a0a1a91149", "sha256": "8f6a80ed63ad320fab9dfbbb1e2f13324efcf0c9ab8ba397e6d45603822daa8f" }, "downloads": -1, "filename": "pyheos-0.5.1.tar.gz", "has_sig": false, "md5_digest": "dffdbce37d4b014f616a32a0a1a91149", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27378, "upload_time": "2019-05-02T03:06:53", "url": "https://files.pythonhosted.org/packages/c9/0d/182327aa65695a3f7a6791dfe3d02a1b4b6eef149fa012b57a3627b21e77/pyheos-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "4e3f3401b5cd46c6c191427341f378a0", "sha256": "07a0520999195f53d7c5b10dddad1f093bbe29b7d843da3f01a23533672d3f44" }, "downloads": -1, "filename": "pyheos-0.5.2-py3-none-any.whl", "has_sig": false, "md5_digest": "4e3f3401b5cd46c6c191427341f378a0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 36883, "upload_time": "2019-05-05T20:11:33", "url": "https://files.pythonhosted.org/packages/ed/48/a2b4dce304ff710c3fe2251d07f7d18e192e2e1b716959a781e0a1e27b63/pyheos-0.5.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cb72f46b4b3701a5c93327f0bff563be", "sha256": "0baea383d7cc42111058999108eec4a1c9741ea4aef4669071a253ca0258ec36" }, "downloads": -1, "filename": "pyheos-0.5.2.tar.gz", "has_sig": false, "md5_digest": "cb72f46b4b3701a5c93327f0bff563be", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27497, "upload_time": "2019-05-05T20:11:34", "url": "https://files.pythonhosted.org/packages/b8/fc/f8d0ddb89708cc5454cf0a143198eb31f3e548bcd48ffe20ba86a6daae6b/pyheos-0.5.2.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "01516abccb6b915c5574abcf91de908e", "sha256": "19d44277365c48d8e971c54d264063ece7aa0441778a7a5c929d0a417b52adc4" }, "downloads": -1, "filename": "pyheos-0.6.0-py3-none-any.whl", "has_sig": false, "md5_digest": "01516abccb6b915c5574abcf91de908e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38006, "upload_time": "2019-08-25T01:26:16", "url": "https://files.pythonhosted.org/packages/43/2a/a7af2cb946c9ffc7aa1c24d55feb8896176c3c736e4cacc304de82592334/pyheos-0.6.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a7349e972e7a61ec9f3c3afd97c657dd", "sha256": "fcb00cd6a2332b0603945cae1e9385c35e4fc228bd124e5fac1d550e3bd67ffd" }, "downloads": -1, "filename": "pyheos-0.6.0.tar.gz", "has_sig": false, "md5_digest": "a7349e972e7a61ec9f3c3afd97c657dd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28118, "upload_time": "2019-08-25T01:26:18", "url": "https://files.pythonhosted.org/packages/cd/3d/32dfe15868ceae71bd569d29bcabe765ab06f1b92b6cd240e2bdd16776bf/pyheos-0.6.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "01516abccb6b915c5574abcf91de908e", "sha256": "19d44277365c48d8e971c54d264063ece7aa0441778a7a5c929d0a417b52adc4" }, "downloads": -1, "filename": "pyheos-0.6.0-py3-none-any.whl", "has_sig": false, "md5_digest": "01516abccb6b915c5574abcf91de908e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38006, "upload_time": "2019-08-25T01:26:16", "url": "https://files.pythonhosted.org/packages/43/2a/a7af2cb946c9ffc7aa1c24d55feb8896176c3c736e4cacc304de82592334/pyheos-0.6.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a7349e972e7a61ec9f3c3afd97c657dd", "sha256": "fcb00cd6a2332b0603945cae1e9385c35e4fc228bd124e5fac1d550e3bd67ffd" }, "downloads": -1, "filename": "pyheos-0.6.0.tar.gz", "has_sig": false, "md5_digest": "a7349e972e7a61ec9f3c3afd97c657dd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28118, "upload_time": "2019-08-25T01:26:18", "url": "https://files.pythonhosted.org/packages/cd/3d/32dfe15868ceae71bd569d29bcabe765ab06f1b92b6cd240e2bdd16776bf/pyheos-0.6.0.tar.gz" } ] }