add breaking changes descriptions (#11739)

* add breaking changes descriptions

Breaking changes descriptions added

* suggested fixes

* clean up icloud description

* removed tahoma breaking change

pr for removing tahoma was reverted

* fixed webostv entry
This commit is contained in:
cogneato 2020-01-14 12:45:58 -07:00 committed by Paulus Schoutsen
parent e43096d7aa
commit e7c56b9150

View File

@ -119,28 +119,131 @@ Experiencing issues introduced by this release? Please report them in our [issue
## Breaking Changes
- Use "kB" and "s" as UPnP/IGD units ([@scop] - [#29552]) ([upnp docs]) (breaking change)
- Change state values for Worx Landroid sensor ([@geraldhansen] - [#27453]) ([worxlandroid docs]) (breaking change)
- Remove Tahoma component #29744 ([@tetienne] - [#29745]) ([tahoma docs]) (breaking change)
- Add config flow to iCloud ([@Quentame] - [#28968]) ([icloud docs]) (breaking change)
- (Re)Add support for multiple Pi-Holes ([@johnluetke] - [#27569]) ([pi_hole docs]) (breaking change)
- Migrate to api_key ([@eifinger] - [#29966]) ([here_travel_time docs]) (breaking change)
- Refactor ZHA electrical measurement sensor. ([@Adminiuga] - [#30130]) ([zha docs]) (breaking change)
- Update Integration of Keba charging station ([@dannerph] - [#30125]) ([keba docs]) (breaking change)
- Enable config flow for Tesla ([@alandtse] - [#28744]) ([tesla docs]) (breaking change)
- Make Huawei LTE notify service name configurable ([@scop] - [#30208]) ([huawei_lte docs]) (breaking change)
- Remove Amcrest deprecated sensors and switches ([@pnbruckner] - [#30308]) ([amcrest docs]) (breaking change)
- Add separate command and state topics for mqtt lock ([@tuxbox] - [#29808]) ([mqtt docs]) (breaking change)
- Migrate webostv to new library and make integration async with callback state updates ([@bendavid] - [#29296]) ([webostv docs]) (breaking change)
- Cleanup of state handling in webostv ([@bendavid] - [#30416]) ([webostv docs]) (breaking change)
- Axis - Remove manual configuration and legacy config file import ([@Kane610] - [#30365]) ([axis docs]) (breaking change)
- Improve WLED pure white support for RGBW ([@frenck] - [#30477]) ([wled docs]) (breaking change)
- Fire restarted event on restarting active timer ([@mnigbur] - [#30475]) ([timer docs]) (breaking change)
- Remove `suppress_warning` from config options for vizio component ([@raman325] - [#30536]) ([vizio docs]) (breaking change)
- Entity Component to no longer generate automatic groups ([@balloob] - [#23789]) ([automation docs]) ([calendar docs]) ([cover docs]) ([device_tracker docs]) ([fan docs]) ([light docs]) ([lock docs]) ([plant docs]) ([remember_the_milk docs]) ([remote docs]) ([script docs]) ([switch docs]) ([vacuum docs]) (breaking change)
- Bump pyRFXtrx to 0.25 ([@Ernst79] - [#30566]) ([rfxtrx docs]) (breaking change)
- Add Ring config flow ([@balloob] - [#30564]) ([ring docs]) (breaking change) (beta fix)
- Update ON/OFF condition and triggers to match documentation and UI, issue #30462 ([@davet2001] - [#30663]) ([binary_sensor docs]) (breaking change) (beta fix)
- __Default groups__ - Entity integrations will no longer automatically maintain the hidden groups with all of their entities. The following groups are no longer automatically created and maintained:
- group.all_automations
- group.calendar
- group.all_covers
- group.all_devices
- group.all_fans
- group.all_lights
- group.all_locks
- group.all_plants
- group.remember_the_milk_accounts (???)
- group.all_remotes
- group.all_scripts
- group.all_switches
- group.all_vacuum_cleaners
The automation and script config panels have been updated to show and manage all automations/scripts. If you want to show cards in your UI with all entities for a single domain, use the auto-entities card. If you want to target all entities in a service call, use 'all' as value for entity_id. - ( [@balloob] - [#23789]) ([automation docs]) ([calendar docs]) ([cover docs]) ( [device_tracker docs]) ([fan docs]) ([light docs]) ([lock docs]) ([plant docs]) ([remember_the_milk docs]) ([remote docs]) ([script docs]) ([switch docs]) ([vacuum docs])
- __UPNP__ - UPnP/IGD units of measurement have been aligned with other integrations and common uses, they're now kB and kB/s instead of kbyte and kbyte/sec respectively. - ([@scop] - [#29552]) ([upnp docs])
- __Worx Landroid__ - The worxlandroid sensor has been changed to not return the hard coded state values "manual-stop", "charging", "charging-complete", "going-home", "mowing" and instead use the states given from the landroid to Home Assistant. This includes the state "idle" which means that something is broken with the mower and you can use this as notification to check the physical state of the mower. Users need to update any automations that depend on the state of the sensor. - ([@geraldhansen] - [#27453]) ([worxlandroid docs])
- __Apple iCloud__ - The iCloud component is no longer part of the device_tracker platform and is now an integration which is configurable via the UI. The iCloud cookie folder moved from `[HA_dir]/icloud` to `[HA_dir]/.storage/icloud`.- ([@Quentame] - [#28968]) ([icloud docs])
- __Pi-hole__ - The default value for host was removed, and now must be specified manually. - ([@johnluetke] - [#27569]) ([pi_hole docs])
Example configuration:
```yaml
pi_hole:
- host: pi.hole
ssl: false
- host: backup.pi.hole
```
- __HERE Travel Time__ - HERE has deprecated the usage of app_code. New users can only generate an api_key. Existing users have to follow the [migration guide](https://developer.here.com/documentation/authentication/dev_guide/topics/api-key-credentials.html) in order to retrieve the now required api_key. - ([@eifinger] - [#29966]) ([here_travel_time docs])
Example configuration:
```yaml
sensor:
- platform: here_travel_time
api_key: "YOUR_API_KEY"
origin_latitude: "51.222975"
origin_longitude: "9.267577"
destination_latitude: "51.257430"
destination_longitude: "9.335892"
```
- __ZHA__ - The default divisor for active_power has changed. Now, multiplier and divisor both default to 1 if the device does not support these attributes or we fail to get those attributes from the device. - ([@Adminiuga] - [#30130]) ([zha docs])
- __Keba__ - The unique_ids of the entities have changed and are now more future proof. The default name and entity_id of the entities have also changed. Users need to clear stale entries from the entity registry and update concerned automations and scripts. - ([@dannerph] - [#30125]) ([keba docs])
- __Tesla__ - Config flow has been added for Tesla. Device tracker entity names have changed due to the conversion to config_flow. They now follow the naming convention of the rest of the Tesla entities. The `id` device tracker entity attribute was also removed because it is a duplicate of `trackr_id`. - ([@alandtse] - [#28744]) ([tesla docs])
- __Huawei LTE__ - The Huawei LTE notify service name is now configurable. The default name for the Huawei LTE notify service has changed to `notify.huawei_lte` to avoid conflicts with other notify services. An option to provide a name for the service has also been added. - ([@scop] - [#30208]) ([huawei_lte docs])
Example configuration:
```yaml
huawei_lte:
- url: ...
password: ...
notify:
name: sms
```
- __Amcrest__ *(Removed)* - Amcrest sensors and switches that were deprecated in previous releases have now been removed. - ([@pnbruckner] - [#30308]) ([amcrest docs])
Example configuration:
```yaml
amcrest:
- ...
sensors:
# This sensor type is no longer supported and must be removed.
- motion_detector
# All switch types are no longer supported and must be removed.
switches:
- motion_detection
- motion_recording
```
- __MQTT__ - Add separate command and state topics for mqtt lock. Two new properties were introduced with `state_locked` (default: LOCKED) and `state_unlocked` (default: UNLOCKED). If you were using the same topic as `state_topic` as for the `command_topic` you can reestablish the old behaviour by setting `state_locked` to *LOCK* and `state_unlocked` to *UNLOCK*. Effectively this change allows you to distinguish commands and states in two topics with different values. - ([@tuxbox] - [#29808]) ([mqtt docs])
Example configuration:
```yaml
lock:
- platform: mqtt
command_topic: "/dev/ha/lock/cmd"
state_topic: "/dev/ha/lock/state"
value_template: "{{ value_json.state }}"
state_locked: "locked"
state_unlocked: "unlocked"
```
- __LG webOS Smart TV__ - The component setup now uses the `webostv` domain instead of `media_player`. The host configuration option is now required and the timeout and filename options have been removed. The state handling for webOStv has also been cleaned up. An entity will have STATE_ON when the tv is on instead of STATE_PLAYING or STATE_PAUSED as was previously the case. Users will need to update automations that depend on entity state. - ([@bendavid] - [#29296] [#30416]) ([webostv docs])
Example configuration:
```yaml
webostv:
name: LG TV
host: 192.168.1.53
#other settings
turn_on_action:
service: wake_on_lan.send_magic_packet
data:
mac: "00:00:00:00:00:00"
standby_connection: true
```
- __Axis__ - Axis integration will no longer accept manual configuration of devices, all configuration of the Axis integration will now be handled from the integrations pane. - ([@Kane610] - [#30365]) ([axis docs])
TL;DR This will no longer work:
```yaml
axis:
```
- __WLED__ - Improves WLED pure white support for RGBW. When using WLED with RGBW strips, setting the color in Home Assistant to white, will turn off the RGB LEDs of the strip and use the W channel only. - ([@frenck] - [#30477]) ([wled docs])
- __Timer__ - Fire restarted event on restarting active timer. This can break automations that should trigger on every timer start event. - ([@mnigbur] - [#30475]) ([timer docs])
- __Vizio__ - Removed `suppress_warning` from config options for vizio component. The pyvizio component now suppresses insecure HTTPS request warnings in a way that doesn't affect global requests from other components, HA, etc. There is no need to globally suppress insecure warnings now. - ([@raman325] - [#30536]) ([vizio docs])
Example configuration:
```yaml
media_player:
- platform: vizio
host: '<IP>:<PORT>'
access_token: '<AUTH_TOKEN>'
device_class: tv
```
- __RFXtrx__ - Bump pyRFXtrx to 0.25. This update switches the commands for 'open' and 'close' for rfxtrx covers of the 'Rollertrol' type, as they were switched (clicking open resulted in closing of the cover and vice versa). Existing automations should be updated. - ([@Ernst79] - [#30566]) ([rfxtrx docs])
- __Ring__ - Ring is now configurable via a config entry. This means it will no longer store the username and password and you're able to configure accounts that use 2FA. It's no longer possible to set scan interval, monitored conditions or ffmpeg arguments. The defaults are used. - ([@balloob] - [#30564]) ([ring docs])
- __Binary Sensor (Locks)__ - Updated ON/OFF condition and triggers to match the documentation and UI. This change inverts the logic of automations relating to binary sensor with the `lock` device class, but only for automations triggered on the lock state (rather than triggering a lock/unlock action).
For users who had already created automations, they will need to be checked and probably inverted. The text displayed in the trigger or condition dropdowns in lovelace will now be correct.
One possible scenario is if a user has set an automation using the state of one lock to trigger an action on other lock(s). This change would cause the action to trigger on `locking` if it was previously triggering on `unlocking`. - ([@davet2001] - [#30663]) ([binary_sensor docs])
## Beta Fixes