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 image entity component #90564

Merged
merged 10 commits into from
Jun 19, 2023
Merged

Add image entity component #90564

merged 10 commits into from
Jun 19, 2023

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Mar 31, 2023

Proposed change

Add image entity component

This is a greatly simplified version of camera which only supports serving a static image.

Frontend support: home-assistant/frontend#16877

In follow-up PRs:

  • Add an integration similar to generic camera for displaying an image from a URL
    • A candidate for this is to add an image platform to the template integration
  • Add MQTT support: Add mqtt image platform #94769

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 Black (black --fast 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:

@allenporter
Copy link
Contributor

I like this simpler standalone image entity! I'm curious to understand the plan for the existing camera or even just generic specifically. The PR description mentions the existing generic camera integration, which my impression can handle this case already, but it brings in other stuff. Is the plan to migrate existing use cases or share implementation? Generally, camera has no path for evolution and is kind of stuck as some virtual entity thing but it's really doing too much and is effectively multiple separate Image + Video Stream entities. I didn't see an architecture discussion for this, so just generally curious about the implications or why why its fine to leave generic behind.

@emontnemery
Copy link
Contributor Author

I like this simpler standalone image entity! I'm curious to understand the plan for the existing camera or even just generic specifically. The PR description mentions the existing generic camera integration, which my impression can handle this case already, but it brings in other stuff. Is the plan to migrate existing use cases or share implementation? Generally, camera has no path for evolution and is kind of stuck as some virtual entity thing but it's really doing too much and is effectively multiple separate Image + Video Stream entities. I didn't see an architecture discussion for this, so just generally curious about the implications or why why its fine to leave generic behind.

The driver for this PR is integrations using the camera entity for things like #80810, modeling that as a "camera" is a really poor fit.

The reference to the generic camera was to provide the means for a user to set up an image entity based on, for example, a URL, similar to how the generic camera allows setting up a camera entity by the user providing URLs for an image or a stream.

@jbouwh jbouwh mentioned this pull request Jun 17, 2023
20 tasks
homeassistant/components/image/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/image/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/image/__init__.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft June 19, 2023 10:52
@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.

@emontnemery emontnemery marked this pull request as ready for review June 19, 2023 13:30
@home-assistant home-assistant bot requested a review from frenck June 19, 2023 13:30
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Looks good to me 👍

../Frenck

@frenck frenck merged commit 5303bef into dev Jun 19, 2023
@frenck frenck deleted the image_component branch June 19, 2023 15:03
@github-actions github-actions bot locked and limited conversation to collaborators Jun 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants