Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add video event proxy endpoint for unifiprotect #129980

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

lutzvahl
Copy link

@lutzvahl lutzvahl commented Nov 6, 2024

Proposed change

As of now, unifi protect comes with 2x API endpoints to be used within HA to get
A) a thumbnail for an event: /api/unifiprotect/thumbnail/{nvr_id}/{event_id}:
B) a part of a video from a camera: /api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}:

This CL adds a new proxy endpoint to receive the full video for an event: /api/unifiprotect/video/{nvr_id}/{event_id}. This is needed as the last_changed timestamp of the sensor in HA is not the same as the unifi protect event start date, hence it's impossible in HA to calc the correct start & end timestamps to see the full event video e.g. as part of a notification.

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

Checklist

  • 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][dev-checklist]
  • I have followed the [perfect PR recommendations][perfect-pr]
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • [ X Tests have been added to verify that the new code works.

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

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

  • The [manifest file][manifest-docs] 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.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @lutzvahl

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

home-assistant bot commented Nov 6, 2024

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.

@lutzvahl
Copy link
Author

lutzvahl commented Nov 6, 2024

Codecov is failing with error: Report creating failed: {"message":"Token required because branch is protected"}
Please advise..

@lutzvahl lutzvahl marked this pull request as ready for review November 6, 2024 21:10
@lutzvahl
Copy link
Author

lutzvahl commented Nov 7, 2024

added link to the doc PR home-assistant/home-assistant.io#35629

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unifi protect events start and end time not in sync with HA sensor last_changed
2 participants