# YNCA
Package to control Yamaha receivers that support the YNCA protocol.
According to reports of users and info found on the internet the following receivers should work.
There might be more receivers that support this protocol. If you find some, please leave a message so the list can be updated.
> HTR-4065, HTR-4071, HTR-6064, RX-A660, RX-A700, RX-A710, RX-A720, RX-A740, RX-A750, RX-A800, RX-A810, RX-A820, RX-A830, RX-A840, RX-A850, RX-A1000, RX-A1010, RX-A1020, RX-A1030, RX-A1040, RX-A2000, RX-A2010, RX-A2020, RX-A2070, RX-A3000, RX-A3010, RX-A3020, RX-A3030, RX-A3070, RX-S600D, RX-V473, RX-V475, RX-V477, RX-V481D, RX-V483, RX-V500D, RX-V575, RX-V671, RX-V673, RX-V675, RX-V677, RX-V679, RX-V681, RX-V771, RX-V773, RX-V775, RX-V777, RX-V867, RX-V871, RX-V1067, RX-V1071, RX-V1085, RX-V2067, RX-V2071, RX-V3067, RX-V3071, TSR-700, TSR-7850
Note that only 1 YNCA connection to a receiver can be made at the time (restriction on the receiver side, not this library).
Usually not a problem as the Yamaha AV Control App uses a different protocol which can be used at the same time, but something to be aware of when testing the library.
## Installation
```bash
python3 -m pip install ynca
```
## Contents
The intended API to use is exposed from the toplevel package.
### Classes
#### YncaApi
This is the main class to interact with. The YncaApi class is exposing YNCA subunits and their functions as Python classes/datatypes and allows to connect to devices supporting that API. It keeps a cache which gets updated when values are received from the device so reading attributes is instant as it does not need to query the receiver.
#### YncaConnection
The YncaConnection class creates a basic connection with a YNCA receiver and allows to send/receive YNCA commands. It handles throttling as required by the protocol and informs of received values through a callback. The YncaApi class uses this under the hood.
Use this if all that is needed is a basic connection to a receiver.
#### YncaModelInfo
The YncaModelInfo class is information about features that a specific model supports.
It is technically not really related to the protocol, but since there seems to be no other repository with this info I decided to keep it here.
### Tools
#### YNCA Terminal
The YNCA Terminal provides an interactive terminal for manually sending YNCA commands. It is only intended for manual debugging.
It can be started with commands like below.
```
python3 -m ynca.terminal /dev/ttyUSB0
python3 -m ynca.terminal socket://192.168.178.21:50000
```
#### YNCA Server
This is a very basic YNCA server intended to be just enough for debugging and testing without connecting to a real device.
The server needs to be filled with data from an actual device and it will basically just repeat the same answers as the real device gave (with a few exceptions).
Filling the server can be done by providing it with YNCA logging of a real device, like the ones in the YCNA package repository or a log from your own device e.g. by running `example.py` with loglevel DEBUG (uncomment the line in the example code).
It has some additional commandline options for using different ports, binding to a specific host or testing disconnects
```
python3 -m ynca.server <ynca_repo>/logs/RX-A810.txt
python3 -m ynca.server --host localhost --port 12345 <ynca_repo>/logs/RX-A810.txt
python3 -m ynca.server --help
```
## Example usage
```python
# Create a YncaApi class by specifying the port on your receiver.
# Port could also be e.g. COM3 on Windows or any `serial_url` as supported by PySerial
# Like for example `socket://192.168.178.21:50000` for IP connection
receiver = YncaApi("/dev/tty1")
# Initializing takes a while (~10 seconds for a 2 zone receiver) since it communicates
# quite a lot with the actual device to determine its capabilities.
# Later calls to the subunits are fast.
# The attributes that are still None after initialization are not supported by the subunits
receiver.initialize()
# Every subunit has a dedicated attribute on the `YncaApi` class.
# The name of the attribute is the subunit id as used in YNCA.
# The returned subunit class can be used to communicate with the subunit
sys = receiver.sys
main = receiver.main
print(sys.modelname) # Print the modelname of the system
print(main.zonename) # Print the name of the main zone
# To get notifications when something changes register callback with the subunit
# Note that callbacks are called from a different thread and should not block.
def update_callback(function, value):
print(f"{function} changed to {value} on the MAIN subunit")
main.register_update_callback(update_callback)
# Examples to control a zone
main.pwr = Pwr.ON
main.mute = Mute.OFF
main.inp = Input.HDMI3
main.vol = -50.5
main.vol_up(2)
# When done call close for proper shutdown
receiver.close()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/mvdwetering/ynca",
"name": "ynca",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "automation",
"author": "Michel van de Wetering",
"author_email": "michel.van.de.wetering+ynca@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0d/73/bfb67bc2029b5e49b3972d34e5e8a9bc478c674db85b0ab7b4b3d1ceec4c/ynca-5.13.1.tar.gz",
"platform": null,
"description": "# YNCA\n\nPackage to control Yamaha receivers that support the YNCA protocol.\n\nAccording to reports of users and info found on the internet the following receivers should work.\nThere might be more receivers that support this protocol. If you find some, please leave a message so the list can be updated.\n\n> HTR-4065, HTR-4071, HTR-6064, RX-A660, RX-A700, RX-A710, RX-A720, RX-A740, RX-A750, RX-A800, RX-A810, RX-A820, RX-A830, RX-A840, RX-A850, RX-A1000, RX-A1010, RX-A1020, RX-A1030, RX-A1040, RX-A2000, RX-A2010, RX-A2020, RX-A2070, RX-A3000, RX-A3010, RX-A3020, RX-A3030, RX-A3070, RX-S600D, RX-V473, RX-V475, RX-V477, RX-V481D, RX-V483, RX-V500D, RX-V575, RX-V671, RX-V673, RX-V675, RX-V677, RX-V679, RX-V681, RX-V771, RX-V773, RX-V775, RX-V777, RX-V867, RX-V871, RX-V1067, RX-V1071, RX-V1085, RX-V2067, RX-V2071, RX-V3067, RX-V3071, TSR-700, TSR-7850\n\nNote that only 1 YNCA connection to a receiver can be made at the time (restriction on the receiver side, not this library).\nUsually not a problem as the Yamaha AV Control App uses a different protocol which can be used at the same time, but something to be aware of when testing the library.\n\n\n## Installation\n\n```bash\npython3 -m pip install ynca\n```\n\n## Contents\n\nThe intended API to use is exposed from the toplevel package.\n\n### Classes\n\n#### YncaApi\n\nThis is the main class to interact with. The YncaApi class is exposing YNCA subunits and their functions as Python classes/datatypes and allows to connect to devices supporting that API. It keeps a cache which gets updated when values are received from the device so reading attributes is instant as it does not need to query the receiver.\n\n#### YncaConnection\n\nThe YncaConnection class creates a basic connection with a YNCA receiver and allows to send/receive YNCA commands. It handles throttling as required by the protocol and informs of received values through a callback. The YncaApi class uses this under the hood.\n\nUse this if all that is needed is a basic connection to a receiver.\n\n#### YncaModelInfo\n\nThe YncaModelInfo class is information about features that a specific model supports.\nIt is technically not really related to the protocol, but since there seems to be no other repository with this info I decided to keep it here.\n\n### Tools\n\n#### YNCA Terminal\n\nThe YNCA Terminal provides an interactive terminal for manually sending YNCA commands. It is only intended for manual debugging.\nIt can be started with commands like below.\n\n```\npython3 -m ynca.terminal /dev/ttyUSB0\npython3 -m ynca.terminal socket://192.168.178.21:50000\n```\n\n#### YNCA Server\n\nThis is a very basic YNCA server intended to be just enough for debugging and testing without connecting to a real device.\n\nThe server needs to be filled with data from an actual device and it will basically just repeat the same answers as the real device gave (with a few exceptions).\nFilling the server can be done by providing it with YNCA logging of a real device, like the ones in the YCNA package repository or a log from your own device e.g. by running `example.py` with loglevel DEBUG (uncomment the line in the example code).\n\nIt has some additional commandline options for using different ports, binding to a specific host or testing disconnects\n\n```\npython3 -m ynca.server <ynca_repo>/logs/RX-A810.txt\npython3 -m ynca.server --host localhost --port 12345 <ynca_repo>/logs/RX-A810.txt\npython3 -m ynca.server --help\n```\n\n\n## Example usage\n\n```python\n# Create a YncaApi class by specifying the port on your receiver.\n# Port could also be e.g. COM3 on Windows or any `serial_url` as supported by PySerial\n# Like for example `socket://192.168.178.21:50000` for IP connection\nreceiver = YncaApi(\"/dev/tty1\")\n\n# Initializing takes a while (~10 seconds for a 2 zone receiver) since it communicates\n# quite a lot with the actual device to determine its capabilities.\n# Later calls to the subunits are fast.\n# The attributes that are still None after initialization are not supported by the subunits\nreceiver.initialize()\n\n# Every subunit has a dedicated attribute on the `YncaApi` class.\n# The name of the attribute is the subunit id as used in YNCA.\n# The returned subunit class can be used to communicate with the subunit\nsys = receiver.sys\nmain = receiver.main\n\nprint(sys.modelname) # Print the modelname of the system\nprint(main.zonename) # Print the name of the main zone\n\n# To get notifications when something changes register callback with the subunit\n# Note that callbacks are called from a different thread and should not block.\ndef update_callback(function, value):\n print(f\"{function} changed to {value} on the MAIN subunit\")\n\nmain.register_update_callback(update_callback)\n\n# Examples to control a zone\nmain.pwr = Pwr.ON\nmain.mute = Mute.OFF\nmain.inp = Input.HDMI3\nmain.vol = -50.5\nmain.vol_up(2)\n\n# When done call close for proper shutdown\nreceiver.close()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package to control Yamaha receivers that support the YNCA protocol.",
"version": "5.13.1",
"project_urls": {
"Homepage": "https://github.com/mvdwetering/ynca"
},
"split_keywords": [
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68d4a8301ce0722f57b6b5a72a3337da19f7d4e33816c2a27d484d8779f6cac4",
"md5": "52f909f5e97e534b5a38c651fceb3261",
"sha256": "bf7b035d6948853235e8c95135f84395d4b8c28e148324480f2764785ce35a2c"
},
"downloads": -1,
"filename": "ynca-5.13.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52f909f5e97e534b5a38c651fceb3261",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35363,
"upload_time": "2024-04-06T16:26:27",
"upload_time_iso_8601": "2024-04-06T16:26:27.882945Z",
"url": "https://files.pythonhosted.org/packages/68/d4/a8301ce0722f57b6b5a72a3337da19f7d4e33816c2a27d484d8779f6cac4/ynca-5.13.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d73bfb67bc2029b5e49b3972d34e5e8a9bc478c674db85b0ab7b4b3d1ceec4c",
"md5": "782fd81429283066a42378437ed6b5d5",
"sha256": "5ff7de397c4708d324ca4640824c95dc4718d32e6c86449da8b0981ea36cd28e"
},
"downloads": -1,
"filename": "ynca-5.13.1.tar.gz",
"has_sig": false,
"md5_digest": "782fd81429283066a42378437ed6b5d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41221,
"upload_time": "2024-04-06T16:26:29",
"upload_time_iso_8601": "2024-04-06T16:26:29.283757Z",
"url": "https://files.pythonhosted.org/packages/0d/73/bfb67bc2029b5e49b3972d34e5e8a9bc478c674db85b0ab7b4b3d1ceec4c/ynca-5.13.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 16:26:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mvdwetering",
"github_project": "ynca",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "pyserial",
"specs": [
[
">=",
"3.4"
]
]
}
],
"lcname": "ynca"
}
JSON
