Skip to content

Commit 13cb746

Browse files
committed
Update configuration
1 parent b304f8f commit 13cb746

File tree

4 files changed

+31
-7
lines changed

4 files changed

+31
-7
lines changed

docs/camera-motion-detection.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ For Fully Kiosk Browser, enable "Enable Webcam Access (PLUS)" in `Web Content Se
66

77
## Configuration
88
* Set `camera_motion_detection_enabled` to `true` to enable motion detection.
9+
* Set `camera_motion_detection_stop_screensaver` to `true` to stop the screensaver when motion is detected.
10+
* With `camera_motion_detection_set_entity`, you can reference an `input_boolean` entity that is updated to mirror the motion detection state (on = motion detected, off = no motion detected).
11+
* Once the duration defined by `camera_motion_detection_motion_stop_delay` has elapsed, the motion detection state is reset to *no motion detected*.
912
* Use `camera_motion_detection_facing_mode` (`user`, `environment`, `left` or `right`) to configure which camera should be used (default: `user`).
1013
* With `camera_motion_detection_threshold` the percentage of changed pixels required for detection can be defined (default: `5`).
1114
* The resolution of the video recording can be configured via `camera_motion_detection_capture_width` (default: `64`) and `camera_motion_detection_capture_height` (default: `48`). Higher values improve accuracy but increase CPU utilization.

docs/configuration.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,19 @@ You can set the following configuration parameters for every individual Home Ass
4141
| screensaver_start_navigation_path | Path to navigate to (e.g., /lovelace/default_view) when screensaver is started. Use a complete path to avoid redirects which will stop the screensaver. | |
4242
| screensaver_stop_close_browser_mod_popup | Close the active browser mod popup when screensaver is stopped? | false |
4343
| screensaver_entity | An entity of type 'input_boolean' to reflect and change the screensaver state (on = started, off = stopped). If browser_mod is installed, `${browser_id}` will be replaced with Browser ID (see [Browser Mod](browser-mod.md#placeholder-browser_id)). | |
44+
| disable_context_menu | Disable context menu while screensaver is running? | false |
4445
| show_images | Show images if screensaver is active? | true |
4546
| image_url | Fetch screensaver media files from this URL. See [Media Sources](media-sources.md) for details. | See [Media Sources](media-sources.md) |
4647
| force_load_media_with_fetch | Enforce media loading through `fetch()` instead of setting the elements `src` attribute. | false |
4748
| image_url_entity | An entity of type 'input_text' in which the URL of the current screen saver image is stored. If browser_mod is installed, `${browser_id}` will be replaced with Browser ID (see [Browser Mod](browser-mod.md#placeholder-browser_id)). | |
4849
| media_entity_load_unchanged | Should a new image be fetched from the entity after the display time has expired, even if the entity's state remains unchanged? | true |
4950
| iframe_load_unchanged | Should an iframe be reloaded once its display time has expired, even if its URL remains the same? | false |
5051
| iframe_interaction | Allow interaction with the iframe content? | false |
51-
| immich_api_key | API key that is used for authentication at the [immich API](media-sources.md#immich-api) | |
52+
| immich_api_keys | API keys that are used for authentication at the [immich API](media-sources.md#immich-api) | [] |
5253
| immich_shared_albums | Display media from shared Immich albums. | true |
5354
| immich_album_names | Display media only from the specified Immich albums. | [] |
5455
| immich_tag_names | Display media only with the specified tags. | [] |
56+
| immich_exclude_tag_names | Exclude media with the specified tags. | [] |
5557
| immich_persons | Display media only featuring the specified people. | [] |
5658
| immich_memories | Display only today’s memories. | false |
5759
| immich_favorites | Display only media marked as favorite. | false |
@@ -87,6 +89,7 @@ You can set the following configuration parameters for every individual Home Ass
8789
| info_move_pattern | Movement pattern of the info box at a specified interval (possible values are: random / corners). | random |
8890
| info_move_interval | Interval of movement of the info box in seconds (0 = no movement). | 0 |
8991
| info_move_fade_duration | Duration of the fade-in and fade-out animation of the info box in case of movement (0 = no animation). | 2.0 |
92+
| theme | Specifies the Home Assistant theme to apply to the info box. Defaults to the theme defined in the user profile. | |
9093
| style | Additional CSS styles for WallPanel elements. | {} |
9194
| badges | Badges to display in info box. Set to [] to show no badges at all. See [Badges](info-box.md#badges) for details. | [] |
9295
| cards | Cards to display in info box. Set to [] to show no cards at all. See [Cards](info-box.md#cards) for details. | [] |
@@ -96,8 +99,11 @@ You can set the following configuration parameters for every individual Home Ass
9699
| profile | Configuration profile to activate. If browser_mod is installed, `${browser_id}` will be replaced with Browser ID (see [Browser Mod](browser-mod.md#placeholder-browser_id)). | |
97100
| profile_entity | An entity of type 'input_text' used for dynamic activation of profiles. If browser_mod is installed, `${browser_id}` will be replaced with Browser ID (see [Browser Mod](browser-mod.md#placeholder-browser_id)). | |
98101
| camera_motion_detection_enabled | Activate camera based motion detection? Screensaver is stopped when movement is detected See [Camera motion detection](camera-motion-detection.md) for details. | false |
102+
| camera_motion_detection_stop_screensaver | Stop screensaver when motion is detected? | true |
103+
| camera_motion_detection_set_entity | An entity of type 'input_boolean' to update with the motion detection state (on = motion detected, off = no motion detected). | |
99104
| camera_motion_detection_facing_mode | Which camera to use (user / environment / left / right). | user |
100105
| camera_motion_detection_threshold | If this many percent of the pixels change between two images, this is counted as movement. | 5 |
106+
| camera_motion_detection_motion_stop_delay | The time in seconds to wait after motion stops before resetting the state to no motion detected. | 2.0 |
101107
| camera_motion_detection_capture_width | Width of the images captured by the camera in pixels. | 64 |
102108
| camera_motion_detection_capture_height | Height of the images captured by the camera in pixels. | 48 |
103109
| camera_motion_detection_capture_interval | Interval in seconds at which images are captured by the camera. | 0.3 |

docs/media-sources.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ traefik.http.routers.immich.middlewares=immich-cors
178178
To access the Immich API, first generate an [API key](https://immich.app/docs/features/command-line-interface/#obtain-the-api-key).
179179

180180
Then you can configure WallPanel to use the Immich API.
181-
You need to set the `image_url` to `immich+<your api url>` and enter the API key in `immich_api_key`.
181+
You need to set the `image_url` to `immich+<your api url>` and add the API key to `immich_api_keys`.
182+
Multiple API keys can be added to use multiple accounts on the same server.
182183
With the config option `immich_shared_albums` (`true` / `false`) you can include or exclude shared albums.
183184
To restrict the media items to be retrieved to specific albums, you can configure a list of album names in `immich_album_names`.
184185
Alternatively you can configure a list of tag names in `immich_tag_names`.
@@ -189,7 +190,8 @@ With the config option `immich_resolution` (`preview` / `original`) you can sele
189190
Example using album names:
190191
```yaml
191192
image_url: immich+https://immich.your.domain/api
192-
immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
193+
immich_api_keys:
194+
- 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
193195
immich_shared_albums: false
194196
immich_album_names:
195197
- Tokio
@@ -200,7 +202,8 @@ immich_resolution: preview
200202
Example using tag names:
201203
```yaml
202204
image_url: immich+https://immich.your.domain/api
203-
immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
205+
immich_api_keys:
206+
- 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
204207
immich_tag_names:
205208
- Family
206209
- Friends
@@ -210,7 +213,8 @@ immich_resolution: original
210213
Example of media elements that contain certain persons:
211214
```yaml
212215
image_url: immich+https://immich.your.domain/api
213-
immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
216+
immich_api_keys:
217+
- 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
214218
immich_persons:
215219
- Alice
216220
- Bob
@@ -221,14 +225,16 @@ This will show media items containing either Alice, Bob or John and Jane.
221225
Example showing immich memories:
222226
```yaml
223227
image_url: immich+https://immich.your.domain/api
224-
immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
228+
immich_api_keys:
229+
- 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
225230
immich_memories: true
226231
```
227232

228233
Example showing immich favorites:
229234
```yaml
230235
image_url: immich+https://immich.your.domain/api
231-
immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
236+
immich_api_keys:
237+
- 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
232238
immich_favorites: true
233239
```
234240

docs/styling.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# Styling
2+
You can use the `theme` configuration option to specify the theme for the WallPanel Info Box.
3+
4+
**Example**
5+
6+
```yaml
7+
wallpanel:
8+
theme: Frosted Glass
9+
```
10+
211
You can customize the style of every WallPanel element.
312
413
The most important element IDs are:

0 commit comments

Comments
 (0)