Add config flow for Vivotek integration by HarlemSquirrel · Pull Request #154801 · home-assistant/core

HarlemSquirrel · 2025-10-19T00:20:29Z

Proposed change

Add config flow for Vivotek integration

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:
Link to developer documentation pull request:
Link to frontend pull request: Vivotek add config flow home-assistant.io#41395

Checklist

I understand the code I am submitting and can explain how it works.
The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

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

Documentation added/updated for www.home-assistant.io

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

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

Copilot

Pull Request Overview

This PR adds config flow support to the existing Vivotek integration, enabling users to configure Vivotek IP cameras through the Home Assistant UI instead of only through YAML configuration. The implementation includes both initial setup and reconfiguration capabilities.

Key changes:

Adds config flow implementation with user setup and reconfiguration steps
Updates the integration to support both YAML and config entry setup methods
Extracts constants to a separate module for better organization

Reviewed Changes

Copilot reviewed 6 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`homeassistant/components/vivotek/config_flow.py`	New config flow implementation with user and reconfigure steps
`homeassistant/components/vivotek/const.py`	New constants file extracting domain-specific configuration keys
`homeassistant/components/vivotek/strings.json`	New localization strings for config flow UI
`homeassistant/components/vivotek/manifest.json`	Enables config flow support in manifest
`homeassistant/components/vivotek/camera.py`	Updates camera platform to support config entries and refactors existing code
`homeassistant/components/vivotek/__init__.py`	New entry point for config entry setup and unloading

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

home-assistant · 2025-10-21T12:39:07Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

erwindouna

Making good progress, @HarlemSquirrel! I've left some points. :)

erwindouna · 2025-10-30T07:17:22Z

+        if "ip_address" in import_data:
+            user_input[CONF_IP_ADDRESS] = import_data["ip_address"]
+        if "name" in import_data:
+            user_input[CONF_NAME] = import_data["name"]
+        if "username" in import_data:
+            user_input[CONF_USERNAME] = import_data["username"]
+        if "password" in import_data:
+            user_input[CONF_PASSWORD] = import_data["password"]
+        if "authentication" in import_data:
+            user_input[CONF_AUTHENTICATION] = import_data["authentication"]
+        if "ssl" in import_data:
+            user_input[CONF_SSL] = import_data["ssl"]
+        if "verify_ssl" in import_data:
+            user_input[CONF_VERIFY_SSL] = import_data["verify_ssl"]
+        if "framerate" in import_data:
+            user_input[CONF_FRAMERATE] = import_data["framerate"]
+        if "security_level" in import_data:
+            user_input[CONF_SECURITY_LEVEL] = import_data["security_level"]
+        if "stream_path" in import_data:
+            user_input[CONF_STREAM_PATH] = import_data["stream_path"]


Can this be made to switch-case?

I don't think so because we need all of these not just one of them

Why do we need so many safe-guards? Aren't there better solutions?

I think it's good to note that the validation of the existing YAML still stands, so we already know what we could expect. So yes, I think we can improve this

joostlek · 2025-11-17T14:10:35Z

+        sec_lvl=data[CONF_SECURITY_LEVEL],  # type: ignore[literal-required]
+    )
+    mac = await hass.async_add_executor_job(cam_client.get_mac)
+    assert len(mac) > 0


Why do we have this assert? What happens when this is the case?

Was using it as a way to fail faster but can remove it

joostlek · 2025-11-17T14:17:30Z

+    "doc_url": "https://www.home-assistant.io/integrations/vivotek/"
+}
+
+CONF_SCHEMA = vol.Schema(


Also note, we have support for section() now. Check telegram_bot for an example. It might help splitting easy stuff from complex stuff.

I would also consider that everything that is not part of the connection details (like host, auth) can be an options flow as it would just be configuration.

joostlek · 2025-11-17T14:18:26Z

+        if "ip_address" in import_data:
+            user_input[CONF_IP_ADDRESS] = import_data["ip_address"]
+        if "name" in import_data:
+            user_input[CONF_NAME] = import_data["name"]
+        if "username" in import_data:
+            user_input[CONF_USERNAME] = import_data["username"]
+        if "password" in import_data:
+            user_input[CONF_PASSWORD] = import_data["password"]
+        if "authentication" in import_data:
+            user_input[CONF_AUTHENTICATION] = import_data["authentication"]
+        if "ssl" in import_data:
+            user_input[CONF_SSL] = import_data["ssl"]
+        if "verify_ssl" in import_data:
+            user_input[CONF_VERIFY_SSL] = import_data["verify_ssl"]
+        if "framerate" in import_data:
+            user_input[CONF_FRAMERATE] = import_data["framerate"]
+        if "security_level" in import_data:
+            user_input[CONF_SECURITY_LEVEL] = import_data["security_level"]
+        if "stream_path" in import_data:
+            user_input[CONF_STREAM_PATH] = import_data["stream_path"]


I think it's good to note that the validation of the existing YAML still stands, so we already know what we could expect. So yes, I think we can improve this

Copilot

Pull Request Overview

Copilot reviewed 11 out of 13 changed files in this pull request and generated 2 comments.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

joostlek

So I pushed to the branch as i also didn't want to come back with another bunch of comments, instead this now is in a mergeable state after which we can start improving the integration :)

Add config flow for Vivotek integration

229a399

Copilot AI review requested due to automatic review settings October 19, 2025 00:20

home-assistant Bot added cla-signed config-flow This integration migrates to the UI by adding a config flow Hacktoberfest integration: vivotek new-feature by-code-owner Quality Scale: legacy labels Oct 19, 2025

Copilot AI reviewed Oct 19, 2025

View reviewed changes

Comment thread homeassistant/components/vivotek/__init__.py Outdated

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

Comment thread homeassistant/components/vivotek/camera.py Outdated

HarlemSquirrel and others added 3 commits October 18, 2025 20:52

Update homeassistant/components/vivotek/__init__.py

3133616

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update homeassistant/components/vivotek/config_flow.py

f26ba03

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add config flow tests for vivotek

85aed59

HarlemSquirrel mentioned this pull request Oct 19, 2025

Vivotek add config flow home-assistant/home-assistant.io#41395

Merged

8 tasks

HarlemSquirrel added 2 commits October 19, 2025 14:02

Use port from config

dd741d4

Update requirements

8d51338

erwindouna requested changes Oct 21, 2025

View reviewed changes

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

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

Comment thread homeassistant/components/vivotek/camera.py Outdated

Comment thread homeassistant/components/vivotek/camera.py Outdated

joostlek requested changes Oct 21, 2025

View reviewed changes

Comment thread homeassistant/components/vivotek/camera.py Outdated

home-assistant Bot marked this pull request as draft October 21, 2025 12:39

gjohansson-ST reviewed Oct 23, 2025

View reviewed changes

HarlemSquirrel added 2 commits October 27, 2025 13:51

Add device info

7bb1fd5

Code review fixes

92e6737

HarlemSquirrel requested a review from gjohansson-ST October 27, 2025 14:04

HarlemSquirrel added 6 commits October 29, 2025 22:51

Merge branch 'dev' into vivotek-add-config-flow

fa31269

Use add_suggested_values_to_schema and fix tests

9dd00f6

Remove unused instance var

8f552f2

Format with prettier

0c1c473

fixup! Format with prettier

a7f81b0

Fix security level default config

b19cb57

HarlemSquirrel marked this pull request as ready for review October 30, 2025 03:38

home-assistant Bot requested review from erwindouna and joostlek October 30, 2025 03:38

erwindouna requested changes Oct 30, 2025

View reviewed changes

Code review updates and remove some uneccessary code

bb89459

erwindouna requested changes Oct 30, 2025

View reviewed changes

Comment thread homeassistant/components/vivotek/camera.py Outdated

Comment thread homeassistant/components/vivotek/camera.py Outdated

joostlek requested changes Nov 17, 2025

View reviewed changes

home-assistant Bot marked this pull request as draft November 17, 2025 14:20

HarlemSquirrel added 5 commits November 19, 2025 02:46

Updates from code review

ee1b19a

Update tests

df8f876

Update yaml import

fb6f9b5

Put back plat schema

bd4ae4b

Move framerate to options

db140f3

HarlemSquirrel requested review from Copilot, erwindouna and joostlek November 19, 2025 03:45

HarlemSquirrel marked this pull request as ready for review November 19, 2025 03:46

Copilot started reviewing on behalf of HarlemSquirrel November 19, 2025 03:46 View session

Copilot finished reviewing on behalf of HarlemSquirrel November 19, 2025 03:47

Copilot AI reviewed Nov 19, 2025

View reviewed changes

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

Comment thread homeassistant/components/vivotek/config_flow.py

HarlemSquirrel and others added 5 commits November 18, 2025 23:43

Update homeassistant/components/vivotek/config_flow.py

8aaaba2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Create deprecation issue for config flow change

1d1c8fa

Merge branch 'dev' into vivotek-add-config-flow

99ac290

Fix

7bc7c41

Fix

6caf3f7

joostlek approved these changes Dec 2, 2025

View reviewed changes

joostlek merged commit c67247b into home-assistant:dev Dec 2, 2025
63 checks passed

github-actions Bot locked and limited conversation to collaborators Dec 3, 2025

Uh oh!

Conversation

HarlemSquirrel commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

home-assistant Bot commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erwindouna left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

HarlemSquirrel commented Oct 19, 2025 •

edited

Loading