immich improvements
This commit is contained in:
12
README.md
12
README.md
@@ -34,7 +34,7 @@ slide [-t rotation_seconds] [-T transition_seconds] [-h/--overlay-color overlay_
|
||||
* `aspect(default=a)`: the required aspect ratio of the picture to display. Valid values are 'a' (all), 'l' (landscape) and 'p' (portrait)
|
||||
* `background_opacity(default=150)`: opacity of the background filling image between 0 (black background) and 255
|
||||
* `blur_radius(default=20)`: blur radius of the background filling image
|
||||
* `-v` or `--verbose`: Verbose debug output when running, plus a thumbnail of the original image in the bottom left of the screen
|
||||
* `-v` or `--verbose`: Verbose debug output when running
|
||||
* `--stretch`: When in aspect mode 'l','p' or 'm' crop the image rather than leaving a blurred background. For example, in landscape mode this will make images as wide as the screen and crop the top and bottom to fit.
|
||||
* `-h` or `--overlay-color` the color of the overlay text, in the form of 3 or 6 digits hex rgb string prefixed by `#`, for example `#00FF00` or `#0F0` for color 🟢
|
||||
* `-O` is used to create a overlay string.
|
||||
@@ -69,6 +69,7 @@ The file format is:
|
||||
"rotationSeconds" : 300,
|
||||
"opacity" : 200,
|
||||
"debug" : false,
|
||||
"debugThumbnail" : false,
|
||||
"scheduler" : [
|
||||
{
|
||||
"exclusive" : true,
|
||||
@@ -117,6 +118,7 @@ Supported keys and values in the JSON configuration are:
|
||||
* `opacity` : the same as the command line `-o` argument
|
||||
* `blur` : the same as the command line `-b` argument
|
||||
* `debug` : set to true to enable verbose output from the program
|
||||
* `debugThumbnail` : set to true to draw a small thumbnail of the source image in the bottom left
|
||||
* `mqtt` : MQTT playback control (see below)
|
||||
* `immich` : connect to an Immich server instead of a local path (see below)
|
||||
* `scheduler` : this entry is an array of possible path values and associated settings. This key lets you manage display times/settings for a collection of paths. In the example above the top entry shows ONLY files from a Redit feed between 2 and 4pm, ONLY files from the `show_peak_times` folder from 8am to 10am and then 4pm to 7pm. At all other times it alternates displaying files in the `always_show_1` and `always_show_2` folder.
|
||||
@@ -167,7 +169,7 @@ Immich control topic (`immichTopic`):
|
||||
|
||||
### Immich configuration (lightweight + low power)
|
||||
|
||||
Immich uses an API key and a `/api` base path. This integration requests the asset search endpoint and downloads the configured image size into a local cache before displaying them. That keeps bandwidth and power usage low while still letting `slide` do its normal scaling and transitions. If you have RAW/HEIC images, set `size` to `preview`/`thumbnail` or use `extensions` to limit results to JPEG/PNG; `slide` will also fall back to `preview` if a `fullsize` download isn't readable.
|
||||
Immich uses an API key and a `/api` base path. This integration requests the asset search endpoint and downloads the configured image size into a local cache before displaying them. That keeps bandwidth and power usage low while still letting `slide` do its normal scaling and transitions. If you have RAW/HEIC images, set `size` to `preview`/`thumbnail` or use `extensions` to limit results to JPEG/PNG; `slide` will also fall back to `preview` if a `fullsize` download isn't readable. Immich metadata (EXIF original time / created time) is stored alongside cached assets so `<exifdatetime>` continues to work even if the cached image doesn't contain EXIF data.
|
||||
|
||||
#### Getting an Immich API key
|
||||
|
||||
@@ -192,6 +194,7 @@ Example (single source):
|
||||
"pageSize": 200,
|
||||
"maxAssets": 1000,
|
||||
"refreshSeconds": 300,
|
||||
"skipRetrySeconds": 3600,
|
||||
"cachePath": "~/.cache/slide/immich",
|
||||
"cacheMaxMB": 512,
|
||||
"includeArchived": false
|
||||
@@ -228,6 +231,7 @@ Immich settings:
|
||||
* `pageSize`: assets fetched per page.
|
||||
* `maxAssets`: cap on total assets fetched (0 means no cap).
|
||||
* `refreshSeconds`: refresh interval for reloading Immich assets (0 disables).
|
||||
* `skipRetrySeconds`: retry interval for assets marked unsupported (0 disables retry).
|
||||
* `cachePath`: local cache directory for downloaded images.
|
||||
* `cacheMaxMB`: maximum cache size in MB (0 disables cleanup).
|
||||
* `includeArchived`: include archived assets in search results.
|
||||
@@ -266,6 +270,10 @@ See the `Configuration File` section for details of each setting.
|
||||
* libexif
|
||||
* libmosquitto-dev
|
||||
|
||||
## Home Assistant
|
||||
|
||||
See `doc/homeassistant.md` for a ready-to-use MQTT dashboard and scripts.
|
||||
|
||||
Ubuntu/Raspbian:
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user