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 snapshot service to image entity #110057

Draft
wants to merge 11 commits into
base: dev
Choose a base branch
from

Conversation

NickM-27
Copy link
Contributor

@NickM-27 NickM-27 commented Feb 8, 2024

Proposed change

Integrations are moving from using the camera.entity to image.entity but there is not feature parity when it comes to the services offered for the image.entity. This PR adds the snapshot service to the image entity so users are able to save the images offline for their own usage.

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
  • 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.

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 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Feb 8, 2024

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (image) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of image can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign image Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@emontnemery
Copy link
Contributor

@NickM-27 There are merge conflicts, can you please merge or rebase the PR?

@NickM-27
Copy link
Contributor Author

@emontnemery thanks, rebased 👍

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Mar 20, 2024
@NickM-27
Copy link
Contributor Author

looks like the failing tests are unrelated to these changes

homeassistant/components/image/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/image/__init__.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

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.

@home-assistant home-assistant bot marked this pull request as draft April 21, 2024 03:08
@NickM-27 NickM-27 marked this pull request as ready for review April 21, 2024 12:00
Copy link
Contributor

@allenporter allenporter left a comment

Choose a reason for hiding this comment

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

Thanks, make sure to also update the examples and documentation.

fields:
filename:
required: true
example: "/tmp/snapshot_{{ entity_id.name }}.jpg"
Copy link
Contributor

Choose a reason for hiding this comment

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

The examples need to be updated for the new variables

Copy link
Contributor Author

Choose a reason for hiding this comment

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

because it was corrected to have the entity id instead of the entity or something else?

tests/components/image/test_init.py Show resolved Hide resolved
@@ -354,3 +357,111 @@ async def _wrap_async_get_still_stream(*args, **kwargs):
await hass.async_block_till_done()

await close_future

Copy link
Contributor

Choose a reason for hiding this comment

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

How about adding a test that exercises the entity template variables?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, can you elaborate? I am not 100% sure what you mean by that

Copy link
Contributor

Choose a reason for hiding this comment

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

Add a test case that in the template references the variables that are used in the examples.

Copy link
Contributor

Choose a reason for hiding this comment

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

Like add a test that uses a filename of /tmp/snapshot_{{ entity_id.name }}.jpg

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.

None yet

4 participants