Migrate Hikvision integration to config flow#158279
Merged
joostlek merged 31 commits intoDec 16, 2025
Merged
Conversation
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
home-assistant
Bot
added
breaking-change
cla-needed
config-flow
Contributor
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Contributor
|
Hey there @mezz64, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
8a0a487 to
24dcd68
Compare
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
64ac443 to
c78d95d
Compare
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
d3eb10a to
a18bf82
Compare
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
a18bf82 to
2c1a048
Compare
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
2c1a048 to
4e409e3
Compare
MartinHjelmare
previously requested changes
Dec 8, 2025
ptarjan
pushed a commit
to ptarjan/pyHik
that referenced
this pull request
Dec 8, 2025
These functions extend the event detection capabilities to support NVRs with non-standard notification methods (record, email, beep) in addition to the existing 'center' and 'HTTP' methods. - get_nvr_events: Fetches events from NVR with broader notification support - inject_events_into_camera: Injects discovered events into HikCamera - HikCamera.inject_events: New method to inject events into camera's state Based on home-assistant/core#158279
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
4e409e3 to
23332a7
Compare
The entry object is only used to access runtime_data, so we don't need to store the entry itself.
Use requests.exceptions.RequestException instead of bare Exception for more precise error handling when connecting to Hikvision devices.
Remove the reauthentication flow as requested by reviewer. This can be added in a follow-up PR.
Preserve the user-configured name from YAML configuration when importing to config entry. Falls back to device name or host.
Use HOMEASSISTANT_DOMAIN for the successful YAML import deprecation issue, matching the pattern used by other integrations like nederlandse_spoorwegen. This uses the shared translation strings.
- Remove reauth flow tests (reauth removed for follow-up PR) - Use requests.exceptions.RequestException instead of Exception - Update deprecated_yaml issue tests to use HOMEASSISTANT_DOMAIN
- Merge mock_hikcamera and mock_hikcamera_config_flow into single fixture - Patch both HikCamera locations using combined context manager pattern - Remove unnecessary MagicMock assignments (autospec handles methods) - Fix fetch_attributes to use return_value assignment syntax
- Use combined mock_hikcamera fixture - Reuse result variable instead of result2, result3 - Remove unnecessary async_block_till_done() calls - Add unique_id assertions to verify entry uniqueness - Merge error tests to include recovery (end in CREATE_ENTRY)
- Merge test_setup_entry and test_unload_entry into single test - Remove runtime_data internal assertions - Remove test_setup_entry_no_device_id (implementation detail) - Remove test_setup_entry_default_name/type tests
- Use issue_registry fixture instead of getting from hass - Use combined mock_hikcamera fixture from conftest - Consolidate entity tests (unique_id, attributes covered in main test)
Use snapshot_platform helper to capture entity registry and state snapshots for all binary sensor entities.
- Import CONF_DELAY from homeassistant.const (existing constant) - Define CONF_IGNORED, DEFAULT_DELAY, DEFAULT_IGNORED locally in binary_sensor.py to match original code structure
- Add test for device_id None case in async_setup_entry - Add test for import flow when device_id is None - Add test for YAML import abort creating issue - Add test for binary sensor update callback - Remove unused timer cancellation code (dead code from delay feature)
ptarjan
force-pushed
the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
from
fabbe62 to
c11fb3f
Compare
Contributor
Author
|
Anything you need from me for this PR? |
joostlek
approved these changes
Dec 16, 2025
Member
joostlek
left a comment
joostlek
left a comment
There was a problem hiding this comment.
Awesome!
Will you also look into becoming codeowner? And maybe send me a message on Discord
Member
|
@ptarjan The documentation also needs to be updated |
8 tasks
ptarjan
deleted the
claude/migrate-hikvision-integration-012bm7PWpikgSddSEixptrqe
branch
heindrichpaul
pushed a commit
to heindrichpaul/core
that referenced
this pull request
Dec 17, 2025
Co-authored-by: Kamil Breguła <mik-laj@users.noreply.github.com>
mezz64
added a commit
to mezz64/pyHik
that referenced
this pull request
Dec 18, 2025
* Add get_nvr_events and inject_events_into_camera functions These functions extend the event detection capabilities to support NVRs with non-standard notification methods (record, email, beep) in addition to the existing 'center' and 'HTTP' methods. - get_nvr_events: Fetches events from NVR with broader notification support - inject_events_into_camera: Injects discovered events into HikCamera - HikCamera.inject_events: New method to inject events into camera's state Based on home-assistant/core#158279 * Add tests for get_nvr_events and inject_events_into_camera Tests cover: - Parsing NVR events with various notification methods (record, email, beep, center) - Skipping videoloss events (used for watchdog) - Handling connection errors gracefully - Handling non-200 responses - Handling invalid XML - Injecting events into camera event_states - Preventing duplicate channel events * Refactor: Add notification_methods parameter to get_event_triggers Instead of a separate get_nvr_events function, extend the existing get_event_triggers method to accept a notification_methods parameter. This allows users to specify which notification methods to accept (defaults to {'center', 'HTTP'} for backwards compatibility). For NVRs, users can pass VALID_NOTIFICATION_METHODS which includes 'record', 'email', and 'beep' in addition to the defaults. Changes: - Add notification_methods parameter to get_event_triggers() - Remove duplicate get_nvr_events function - Export VALID_NOTIFICATION_METHODS constant for easy use - Update tests to cover new parameter functionality --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: mezz64 <2854333+mezz64@users.noreply.github.com>
| device_id = camera.get_id() | ||
| device_name = camera.get_name | ||
| except requests.exceptions.RequestException: | ||
| _LOGGER.exception( |
Member
There was a problem hiding this comment.
We only log unknown exceptions including the stack trace.
Member
There was a problem hiding this comment.
We normally catch broad exception too. Haven't you used our scaffold script to generate the config flow? It has a template to follow.
Contributor
Author
There was a problem hiding this comment.
No i never used the script, I'll check what it does and see if I missed anything. Thanks.
21 tasks
mettolen
pushed a commit
to mettolen/core
that referenced
this pull request
Dec 26, 2025
Co-authored-by: Kamil Breguła <mik-laj@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrate the Hikvision integration from a legacy YAML-based integration to the modern config flow-based system. In the process of this migration I was able to fix the creation of my binary sensors. Now I have:
Breaking change
Users with existing YAML configuration will see a deprecation message.
Proposed change
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: