{"id":27695073,"url":"https://github.com/outadoc/immich-home-assistant","last_synced_at":"2025-07-13T21:08:50.934Z","repository":{"id":224248644,"uuid":"762811806","full_name":"outadoc/immich-home-assistant","owner":"outadoc","description":"Home Assistant component to display random pictures from your Immich library.","archived":false,"fork":false,"pushed_at":"2024-06-18T18:04:06.000Z","size":3684,"stargazers_count":97,"open_issues_count":19,"forks_count":17,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-05T01:39:06.540Z","etag":null,"topics":["diy","home-assistant","home-assistant-integration","home-automation","immich","photo-frame"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outadoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-24T18:56:31.000Z","updated_at":"2025-06-03T11:13:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"9adfc56a-fb73-4f20-a1e7-ac6f5803a2a7","html_url":"https://github.com/outadoc/immich-home-assistant","commit_stats":null,"previous_names":["outadoc/immich-home-assistant"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/outadoc/immich-home-assistant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outadoc%2Fimmich-home-assistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outadoc%2Fimmich-home-assistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outadoc%2Fimmich-home-assistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outadoc%2Fimmich-home-assistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outadoc","download_url":"https://codeload.github.com/outadoc/immich-home-assistant/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outadoc%2Fimmich-home-assistant/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265205776,"owners_count":23727512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diy","home-assistant","home-assistant-integration","home-automation","immich","photo-frame"],"created_at":"2025-04-25T14:15:18.329Z","updated_at":"2025-07-13T21:08:50.914Z","avatar_url":"https://github.com/outadoc.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Immich × Home Assistant ![GitHub Release](https://img.shields.io/github/v/release/outadoc/immich-home-assistant) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/outadoc/immich-home-assistant/validate.yml)\n\nThis custom integration for Home Assistant allows you to display random pictures from your Immich instance right inside your dashboards.\n\n### What is Immich?\n\nImmich is a \"high performance self-hosted photo and video backup solution\".  \n[Find more on their website](https://immich.app).\n\n### What is Home Assistant?\n\nHome Assistant provides \"open source home automation that puts local control and privacy first\".  \n[Find more on their website](https://www.home-assistant.io).\n\n## Installation\n\nInstall this component _via_ [HACS](https://hacs.xyz).\n\n[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?repository=immich-home-assistant\u0026category=Integration\u0026owner=outadoc)\n\nRestart Home Assistant once the integration has been installed.\n\n## What can I do with this project?\n\nAs a suggestion, you could use this integration to create a picture frame. You can create a \"pane\" dashboard, and display your picture entity inside of it:\n\n```yaml\ntype: panel\ntitle: Photo frame\npath: photo-frame\nicon: mdi:image-frame\nsubview: true\ncards:\n  - type: picture-entity\n    entity: image.immich_favorite_image\n    show_state: false\n    show_name: false\n    aspect_ratio: \"16:9\"\n    fit_mode: contain\n```\n\nYou can then use this dashboard on a dedicated device in kiosk mode.\n\nYou could even display in onto a Nest Hub device with the [Home Assistant Cast](https://www.home-assistant.io/integrations/cast/#home-assistant-cast) feature − you can finally say goodbye to Google Photos! 🎉\n\n```yaml\n- service: cast.show_lovelace_view\n  data:\n    entity_id: media_player.\u003cyour-chromecast-device\u003e\n    dashboard_path: lovelace\n    view_path: photo-frame\n```\n\n![A Nest Hub 2 showing a cat picture, straight from Home Assistant](assets/demo.jpg)\n\n## How does it work?\n\nThe integration can provide multiple `image` entities, which each correspond to an album. Each entity will switch to a new random image every 5 minutes.\n\nThese entities can be displayed using standard lovelace cards − for example, the `picture`, or `picture-entity` cards.\n\n\u003cimg src=\"assets/entity-card.png\" width=\"600\" alt=\"Example usage: a picture card showing a picture from Immich\"\u003e\n\n## Configuration\n\nYou can set up the Immich integration right from the web UI.\n\n[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=immich)\n\nYou will need to enter your instance's URL and an API key. You can generate it from your Account Settings, on your Immich instance.\n\n\u003cimg src=\"assets/immich-api-key.png\" width=\"600\" alt=\"'API Keys' section on the Immich account settings page\"\u003e\n\n### Exposing other albums\n\nBy default, only the \"Favorites\" album is exposed as an entity.\n\nYou can expose more albums on the integration's options page.\n\n\u003e [!WARNING]  \n\u003e Exposing many albums might consume a lot of resources on your Home Assistant machine, and will also increase the number of calls to your Immich instance.\n\n\u003cimg src=\"assets/entity-list.png\" width=\"600\" alt=\"A list of four image entities provided by the Immich integration\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutadoc%2Fimmich-home-assistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutadoc%2Fimmich-home-assistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutadoc%2Fimmich-home-assistant/lists"}