Add Config Flow support, Device Registry support, available property to vizio component by raman325 · Pull Request #30653 · home-assistant/core

raman325 · 2020-01-10T20:27:33Z

Breaking Change:

The vizio integration has moved from a platform level config entry to a top level config entry.
the name parameter is an optional parameter. Before config flow, if you didn't provide a name, a default name was set and then HA would auto assign entity ID's based on the name, eg vizio_smartcast and vizio_smartcast_2. Once config flow is available, the names have to be unique otherwise import will fail

Description:

Added user and import based Config Flow support (with tests)
Added Device Registry support
available property to handle disconnects

NOTE: I also removed a bunch of line breaks I added in a recent PR because pydocstyle didn't like it

Pull request in home-assistant.io: home-assistant/home-assistant.io#11704

Example entry for `configuration.yaml` (if applicable):

vizio:
  - host: IP_ADDRESS
    access_token: AUTH_TOKEN

Previously:

media_player:
  - platform: vizio
    host: IP_ADDRESS
    access_token: AUTH_TOKEN

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

…o value that caused error

raman325 · 2020-01-12T06:23:28Z

OK so I removed the OptionsConfigFlow for now and moved CONF_VOLUME_STEP back into the main ConfigFlow because I think I may need to make changes in the base component to support it properly as an option. I also kept the async_set_unique_id check in async_step_import so that I could abort if a flow was already in progress.

…ion names and docstrings to be more accurate

MartinHjelmare · 2020-01-12T13:12:30Z

CONF_VOLUME_STEP should not be part of the main flow. Save it separately and merge it into entry data before creating the entry if imported from config yaml.

MartinHjelmare

See eg how hue config flow does its checks. It uses the bridge id for unique_id but also uses host for checking same entry in the import step.

…ates, set unique ID to serial, fixes based on review

raman325 · 2020-01-13T05:39:41Z

figured out how to make options flow work so added that back in along with addressing your comments

…is set in media_player

… patches to pytest fixtures and fix patch scoping

raman325 · 2020-01-13T21:47:44Z

Thanks for all of the help and patience @MartinHjelmare , I'm learning a lot through this and hopefully this last push does it!

…t can spam logs

raman325 · 2020-01-14T04:40:07Z

I would like to submit a PR for a breaking change that changes the soundbar device type to speaker because speaker is defined in the media_player component and allows the device to be controlled by Alexa and Google Assistant. Should I submit that as a separate change or can I include that here? I'm trying to avoid introducing breaking changes in multiple releases, and it is ready to go.

raman325 · 2020-01-14T04:44:48Z

Also, I would request that this PR, as well as the changes to use speaker as a device class instead of soundbar, get released along with #30536 and #30605 so that all of the breaking changes happen in one release, so that may mean holding those two merged PRs up if this won't make 0.104. The device class change is the last anticipated breaking change.

MartinHjelmare · 2020-01-14T14:07:55Z

It's just the PR that removed the warning suppression that is in the release branch. I think that's ok. The rest of the PRs will go out in the following release 0.105.

…entity unload from tests, other misc changes from review

…D as update signal

MartinHjelmare

Looks good! Let me know if you want to do the final improvement or save that for later.

…volume step

raman325 · 2020-01-14T20:37:14Z

@MartinHjelmare can you review this last change and make sure it was implemented the way you would expect?

…g_entry

MartinHjelmare

Looks good!

raman325 · 2020-01-15T04:17:14Z

This should go out with my next PR which will also be a breaking change

* upstream/dev: (82 commits) Add support for vacuums to Alexa. (home-assistant#30764) Refactor Ring data handling (home-assistant#30777) Restore unit_of_measurement from entity registry (home-assistant#30780) Update pyubee to 0.8 (home-assistant#30785) Update emulated_roku to 0.1.9 (home-assistant#30791) Add Config Flow support, Device Registry support, available property to vizio component (home-assistant#30653) Allow input_* and timer component setup without config (home-assistant#30772) Search: Add search to default config and don't resolve area (home-assistant#30762) [ci skip] Translation update Use storage based collections for Timer platform (home-assistant#30765) Upgrade youtube_dl to version 2020.01.15 (home-assistant#30767) Whitelist Frenck for release Hass.io allow to reset password with CLI (home-assistant#30755) Revert home-assistant#29701 (home-assistant#30766) Add Safe Mode (home-assistant#30723) Update Ring to 0.6.0 (home-assistant#30748) Add support for the voltage sensor on the greeneye GEM (home-assistant#30484) Fix supported_features in MQTT fan (home-assistant#28680) Fix small typo in alarmdotcom component (home-assistant#30758) bump aiokef to 0.2.5 which uses locks (home-assistant#30753) ...

add config flow support, device registry support, available property

36e827d

homeassistant added the cla-signed label Jan 10, 2020

probot-home-assistant Bot added has-tests integration: vizio by-code-owner labels Jan 10, 2020

raise PlatformNotReady if HA cant connect to device

6901bbc

raman325 mentioned this pull request Jan 10, 2020

Update docs to reflect change from platform level to config level entry for vizio component home-assistant/home-assistant.io#11704

Merged

2 tasks

raman325 added 6 commits January 10, 2020 16:03

remove test logging statement and fix integration title

40119bb

store import and last user input values so user can see errors next t…

815a344

…o value that caused error

add PARALLEL_UPDATES

6948023

add missing type hints

7c8d279

add missing type hints to tests

6bdd638

fix options config flow title

19809fb

MartinHjelmare requested changes Jan 11, 2020

View reviewed changes

raman325 added 6 commits January 12, 2020 01:33

changes based on review

e6c3683

better key name for message when cant connect

32df353

fix missed update to key name

28e3bc8

fix comments

3df6767

remove logger from test which was used to debug and update test funct…

ba25691

…ion names and docstrings to be more accurate

add __init__.py to vizio tests module

b6800b7

MartinHjelmare reviewed Jan 12, 2020

View reviewed changes

Comment thread homeassistant/components/vizio/config_flow.py Outdated

Comment thread homeassistant/components/vizio/config_flow.py Outdated

readded options flow and updated main component to handle options upd…

210f30a

…ates, set unique ID to serial, fixes based on review

raman325 requested a review from MartinHjelmare January 13, 2020 05:39

raman325 added 4 commits January 13, 2020 00:43

pop hass.data in media_player unload instead of in __init__ since it …

5a612d8

…is set in media_player

update requirements_all and requirements_test_all

327ae15

make unique_id key name a constant

99f10f7

remove additional line breaks after docstrings

79f5834

remove unnecessary code, use event bus to track options updates, move…

361fba2

… patches to pytest fixtures and fix patch scoping

raman325 added 4 commits January 13, 2020 16:53

fix comment

3d3a6a8

remove translations from commit

d0b6960

suppress API error logging when checking for device availability as i…

33e123a

…t can spam logs

update requirements_all and requirements_test_all

477b952

raman325 requested a review from MartinHjelmare January 14, 2020 13:48

MartinHjelmare reviewed Jan 14, 2020

View reviewed changes

MartinHjelmare added the breaking-change label Jan 14, 2020

raman325 added 2 commits January 14, 2020 10:25

dont pass hass to entity since it is passed to entity anyway, remove …

4fbb9a0

…entity unload from tests, other misc changes from review

fix clearing listeners

57d8e5d

MartinHjelmare reviewed Jan 14, 2020

View reviewed changes

raman325 added 2 commits January 14, 2020 14:25

use config_entry unique ID for unique ID and use config_entry entry I…

69e3e94

…D as update signal

update config flow based on suggested changes

b490291

MartinHjelmare approved these changes Jan 14, 2020

View reviewed changes

Comment thread homeassistant/components/vizio/config_flow.py

update volume step on config import if it doesn't match config_entry …

ba3f5ec

…volume step

MartinHjelmare requested changes Jan 14, 2020

View reviewed changes

Comment thread homeassistant/components/vizio/config_flow.py Outdated

Comment thread homeassistant/components/vizio/config_flow.py Outdated

Comment thread homeassistant/components/vizio/config_flow.py Outdated

update config_entry data and options with new volume step value

2dbff5c

MartinHjelmare reviewed Jan 14, 2020

View reviewed changes

Comment thread homeassistant/components/vizio/config_flow.py Outdated

Comment thread homeassistant/components/vizio/config_flow.py Outdated

copy entry.data and entry.options before updating when updating confi…

08c419e

…g_entry

MartinHjelmare approved these changes Jan 14, 2020

View reviewed changes

fix test_import_entity_already_configured

fc7744f

MartinHjelmare merged commit ac771ad into home-assistant:dev Jan 15, 2020

lock Bot locked and limited conversation to collaborators Jan 16, 2020

Uh oh!

Conversation

raman325 commented Jan 10, 2020 • edited by ludeeus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking Change:

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

raman325 commented Jan 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MartinHjelmare commented Jan 12, 2020

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

raman325 commented Jan 13, 2020

Uh oh!

raman325 commented Jan 13, 2020

Uh oh!

raman325 commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

raman325 commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare commented Jan 14, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

raman325 commented Jan 14, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

raman325 commented Jan 15, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

raman325 commented Jan 10, 2020 •

edited by ludeeus

Loading

Example entry for `configuration.yaml` (if applicable):

raman325 commented Jan 12, 2020 •

edited

Loading

raman325 commented Jan 14, 2020 •

edited

Loading

raman325 commented Jan 14, 2020 •

edited

Loading