Immich Photos

This custom integration for Home Assistant provides a camera entity with photo frame from Immich (self-hosted photo and video management solution).

This integration will set up the following platforms.

Platform	Description
camera	A random image from the random Immich Album.

Installation

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
2. If you do not have a custom_components directory (folder) there, you need to create it.
3. In the custom_components directory (folder) create a new folder called immich_photos.
4. Download all the files from the custom_components/immich_photos/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant

Configuration

1. Add the part of configuration provided below to your configuration.yaml
2. Replace any.valid.url.with.immich.api.available in the configuration parameter url with the valid URL of your Immich.
3. Replace ani.valid.api.key.provided.by.immich in the parameter api_key with the valid API key peovided by your Immich (get or add it in your Immich here: Account settings/API Keys).
4. Set the desired update interval in seconds for albums in update_interval/album parameter. In case you set it equal 0 album wil be randomly updated on each image update.
5. Set the desired update interval in seconds for image in update_interval/image parameter.
6. The configuration parameter shared_albums tells foe component which types of album it should proceed: True - shared, False - owned
7. Again restart Home Assistant

configuration.yaml required part

camera:
  - platform: immich_photos
    url: "any.valid.url.with.immich.api.available"
    api_key: "ani.valid.api.key.provided.by.immich"
    update_interval:
      album: 300
      image: 30
    shared_albums: True

Examples

Dashboard Picture card

type: picture-entity
entity: camera.immich_photos
show_state: false
show_name: false
camera_view: auto
aspect_ratio: '16:9'

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

---