Skip to main content

A python library to control Pioneer VSX AVRs over telnet

Project description

pyoneer_vsx

This is a Python package for interfacing with Pioneer receivers, primarily the VSX series, via telnet commands as outlined in this specification.

This package was primarily created for use with Home Assistant to support receivers that do not work with the current implementation, as well as to extract all of the Pioneer-specific code out of Home Assistant, and to swtich to using a persistent connection via asyncio.

This package is based on python-anthemav which provides similar functionality for Anthem receivers.

Supported functionality

Currently this supports:

  • Power: on/off
  • Volume: 0-100%
  • Mute: on/off
  • Input selection

The spec outlines more functionality, including listening modes, tone control, multi-zone power/input selection, etc, however for my purposes all I needed were the basics above.

Update events

Because we keep a persistent connection to the receiver, we receive events every time a change is made to the receiver, either via a command we sent, or by a person physically interacting with the controls on the device itself.

For this reason we only, and always, update our internal state when we get these events, not when we initially send a command to the receiver.

Setup

Package installation

You can either install the package using pip:

pip3 install pyoneer-vsx

or clone the repo and install/run it from the source.

Receiver

Connect your receiver to your network and ensure it has a static IP address either via the System Setup > Network Setup menu on the receiver itself, or by assigning it a fixed address on your router.

Also make sure you enable the Network Standby feature (also found in the Network Setup menu) so we can still connect to the receiver even when it is powered off.

Testing

I have exclusively tested this with a VSX-822 and a VSX-1121, but any other Pioneer VSX series receiver (and possibly others) should work.

If download the code you can run the following command, substituting in the IP and port as needed:

python3 test_harness.py --host IP_ADDRESS --port PORT

This will attempt to connect to the receiver, turn it on, select a few different inputs, then turn it off, all with very verbose logging. At the end, your receiver should be off and when you turn it back on it should be set to the Blu-ray/BD input.

Caveats

Due to the persistent connection described above, using this package will prevent any other applications/services, such as iOS or Android control apps, from connecting to the receiver.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyoneer_vsx-0.0.3.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyoneer_vsx-0.0.3-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file pyoneer_vsx-0.0.3.tar.gz.

File metadata

  • Download URL: pyoneer_vsx-0.0.3.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for pyoneer_vsx-0.0.3.tar.gz
Algorithm Hash digest
SHA256 0863c5b78544f354433c79e5d16f68abb9aa173822ad14fbc90b17821c750f4a
MD5 b4d5d4682978ddb6da93aeee17ca2a59
BLAKE2b-256 1511260fa45c182f33cf72da976891c5a1ec8ce1b444067bbfa0eb8053f6f9be

See more details on using hashes here.

File details

Details for the file pyoneer_vsx-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyoneer_vsx-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for pyoneer_vsx-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3643b87f41f2c8135cccc792e626a51e38d691beafec0ffac8f9a8ec50c1c669
MD5 25dbc985c901189c53a767587b3e679d
BLAKE2b-256 18795d91404fb0a1bcbaef8f41af73d88f6ece1c8c5eb087ffa21ec030cbbc08

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page