Pioneer AVR (asyncio)

Home Assistant media_player custom integration for Pioneer AVRs. Inspired by the original Pioneer integration. Tested on a VSX-930 (Main Zone and HDZone outputs).

Added support for the following features:

• Supports integration config flow (Configuration > Integrations > + to add) as well as configuration via configuration.yaml.
• Uses the aiopioneer package to communicate with the AVR via its API.
• Auto-detect and create entities for Zones 1, 2, 3 and HDZone.
• Automatically poll AVR for source names - no longer need to manually code them in your config any more if your AVR supports their retrieval.
• Create devices and populate with model, software version and MAC address queried from AVR (if supported) when configured via the UI.

Installation

This custom integration can be installed via HACS by adding this repository manually (documentation to come).

Configuration

This integration may be configured via the UI (Configuration > Integrations > Add Integration) or via configuration.yaml. It is recommended that all AVRs are configured using the same configuration method.

Unlike other integrations, this integration will create media_player entities for all zones that are discovered on an AVR. It is not necessary to configure separate instances of the integration for each zone.

configuration.yaml options

Configure these settings under media_player:

NOTE: See Breaking Changes if you are upgrading from version 0.2 or earlier as configuration options have changed.

AVR sources

If the sources property is not specified, then the integration will attempt to query them from the AVR on startup and when options are updated, and use the friendly names configured on the AVR. This functionality is not supported by all AVR models. If the integration does not detect sources, or only a subset of sources should be selectable, then a mapping can be manually configured via the sources property.

The mapping maps friendly names to IDs. Valid IDs are dependent on the receiver model, and are always two characters. The IDs must be defined as strings (ie. between quotation marks) so that 05 is not implicitly transformed to 5, which is not a valid source ID.

Example source mapping (configuration.yaml): { TV: '05', Cable: '06' }

NOTE: Remember to use JSON syntax when entering sources in the UI, for example: { "TV": "05", "Cable": "06" }

params object

The params object is passed onto the Pioneer AVR API to modify its functionality. Parameters can be configured via the Configure button when the integration is added via the UI, or configured in configuration.yaml otherwise. See the aiopioneer documentation for the available options.

NOTE: Changing ignored_zones or ignore_volume_check via the UI requires Home Assistant to be restarted before fully taking effect.

Breaking changes

• 0.6
  Zone entity unique IDs have changed to conform to unique ID requirements. Due to a bug with integration removal in previous versions, the entity IDs of your zones will probably change after upgrading to this version if you added the integration via the UI. To restore your entity IDs, perform the following steps:

  1. remove the integration via the UI (saving configuration settings).
  2. restart Home Assistant.
  3. in Home Assistant, navigate to Configuration > Entities and search for your Pioneer AVR zone entities. They should show a red exclamation mark in the Status column.
  4. select all the entities and click Remove Entity.
  5. reinstall the integration via the UI and restore configuration settings.

• 0.5
  volume_step_only logic has been rewritten to step the volume until the actual volume reaches (or exceeds) the desired volume. It will stop stepping and log a warning if after the step command the volume does not change or changes in the wrong direction.

• 0.4
  The AVR source query no longer skips source names that have not been renamed. This will result in additional sources being selectable. Specify sources manually to only allow certain sources to be selected.

• 0.3
  command_delay, volume_workaround and volume_steps have been moved into the params object. Additionally, volume_steps has been renamed volume_step_only and volume_workaround has been renamed to power_on_volume_bounce. You will need to update your configuration.yaml accordingly.

Implementation details

• Implemented in asyncio.
• Maintain single continuous telnet session to AVR, with automatic reconnect.
• Eliminate polling where AVR sends keepalive responses (on port 8102).
• Uses crowbarz/aiopioneer to communicate with the Pioneer API.

NOTE: On the VSX-930, the telnet API can become quite unstable when telnet connections are made to it repeatedly. The original integration established a new telnet connection for each command sent to the AVR, including the commands used to poll status. This integration establishes a single telnet connection when loaded, and re-connects automatically if it disconnects. The connection is used for sending commands, receiving responses, and receiving status updates which are reflected in Home Assistant in real time.

Enabling debugging

The Home Assistant integration logs messages to the custom_components.pioneer_async namespace, and the underlying API logs messages to the aiopioneer namespace. See the Logger integration documentation for the procedure for enabling logging for these namespaces.

The debug_* parameters can be set to enable additional debugging messages from the API. These debug options generate significant additional logging, so are turned off by default.