Skip to content

Commit

Permalink
Add deprecation warning for YAML configuration to be implemented in 0…
Browse files Browse the repository at this point in the history
….9.0
  • Loading branch information
crowbarz committed Mar 6, 2024
1 parent 1ef1e95 commit 5159872
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ This integration can be installed via HACS by adding this repository as a custom

## Configuration

> **WARNING:** as of 0.8.6, support for YAML configuration via `configuration.yaml` is deprecated, and will be removed in 0.9.0.
This integration may be configured via the UI (**Configuration > Integrations > +**) or through YAML in `configuration.yaml`. All AVRs should be configured using the same configuration method.

Unlike other similar 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.
Expand All @@ -36,6 +38,8 @@ Additional sources can be manually added by entering them in **Manually configur

## `configuration.yaml` options

> **WARNING:** as of 0.8.6, support for YAML configuration via `configuration.yaml` is deprecated, and will be removed in 0.9.0.
Configure these settings under `media_player`:

| Name | Type | Default | Description
Expand Down Expand Up @@ -208,6 +212,9 @@ To be implemented.

## Breaking changes

- **0.9**\
Integration configuration via `configuration.yaml` is no longer supported. [ADR10](https://github.com/home-assistant/architecture/blob/master/adr/0010-integration-configuration.md) outlines that integrations that communicate with devices, such as this one, must be configured via the UI. Also, several more recently added features, such as support for the HA device registry and dynamic integration loading/unloading, already do not work unless configured via the UI.

- **0.8**\
The `zone_h_sources` and `zone_z_sources` params have been renamed to `hdzone_sources`, to be more consistent with the rest of the integration.

Expand Down

0 comments on commit 5159872

Please sign in to comment.