WallPanel

🖼️ Wall panel mode for your Home Assistant Dashboards. A configurable extension that features a full-screen mode, a photo slideshow screensaver, screen wake lock and the ability to hide the side and top bar(s). Show dashboard cards and badges of your choice on top of the images.

Installation

The recommended way is to install this plugin using HACS.

HACS Installation

• Search for WallPanel in the Frontend repository list
• Click on the repository card
• Click on Install this repository in HACS
• Select the latest version
• Click on Download

Manual installation

• Download wallpanel.js and place it into the folder config/www.
• Open Configuration => Lovelace Dashboards => Resources and add /local/wallpanel.js (Resource type: JavaScript module).

Upgrading

The recommended way is to upgrade this plugin using HACS.

HACS upgrade

• Search for WallPanel in the Frontend repository list
• Click on the repository card
• Click on Install this repository in HACS
• Select the latest version
• Click on Download

Manual upgrade

• Download current wallpanel.js and place it into the folder config/www.
• Open Configuration => Lovelace Dashboards => Resources and modify the resource URL to force browsers to reload the resource. For example you could add or change the query string: /local/wallpanel.js?v2

Configuration

You can set the following configuration parameters for every individual Home Assistant Dashboard:

Config	Description	Default
enabled	Enable WallPanel? You will need to set this to true to activate the wall panel for the dashboard.	false
enabled_on_tabs	Enable WallPanel on the named panel tabs only. If the list is empty, wallpanel is enabled on all tabs.	[]
debug	Enable debug mode?	false
log_level_console	Log level to use for logging to the browser console (error / warn / info / debug).	info
hide_toolbar	Hide the upper panel toolbar? Please see FAQ how to edit your dashboard when toolbar is hidden.	false
hide_toolbar_action_icons	Hide action items in the toolbar?	false
hide_sidebar	Hide the navigation sidebar?	false
fullscreen	Set browser window to fullscreen? Due to browser restrictions you will need to interact with the screen once to activate fullscreen mode after loading the dashboard page.	false
z_index	Wallpanels base CSS z-index.	1000
idle_time	Time in seconds after which the screensaver will start (0 = screensaver disabled).	15
fade_in_time	Screensaver fade-in time in seconds.	3.0
fade_out_time_motion_detected	Screensaver fade-out time in seconds when the screensaver is stopped because motion is detected.	1.0
fade_out_time_screensaver_entity	Screensaver fade-out time in seconds when the screensaver is turned of by the screensaver entity.	3.0
fade_out_time_browser_mod_popup	Screensaver fade-out time in seconds when the screensaver is stopped because of an browser mod popup.	1.0
fade_out_time_interaction	Screensaver fade-out time in seconds when the screensaver is stopped because of user input.	0.3
crossfade_time	Crossfade duration in seconds for screensaver images.	3.0
display_time	Duration in seconds after which the next screensaver image will be shown.	15.0
keep_screen_on_time	Time in seconds for how long to prevent screen to dimm or lock (0 = disabled).	0
black_screen_after_time	Time in seconds after which the screensaver will show just a black screen (0 = disabled).	0
control_reactivation_time	Time in seconds for which interaction with the dashboard is disabled after the screensaver is stopped.	1.0
stop_screensaver_on_mouse_move	Stop screensaver on mouse movement?	true
stop_screensaver_on_mouse_click	Stop screensaver on mouse click / display touch?	true
stop_screensaver_on_location_change	Stop screensaver on navigation (location-changed events)?	true
stop_screensaver_on_key_down	Stop screensaver on key press?	true
disable_screensaver_on_browser_mod_popup	Disable screensaver if a browser mod popup is active?	false
disable_screensaver_on_browser_mod_popup_func	Javascript function to determine whether to disable screensaver based on active browser mod popup (see below)
screensaver_stop_navigation_path	Path to navigate to (e.g., /lovelace/default_view) when screensaver is stopped.
screensaver_stop_close_browser_mod_popup	Close the active browser mod popup when screensaver is stopped?	false
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 below).
show_images	Show images if screensaver is active?	true
image_url	Fetch screensaver images from this URL. See below for details.	See below
immich_api_key	API key that is used for authentication at the immich API.
immich_album_names	Only show images from these immich albums.	[]
immich_resolution	The resolution to use for loading images from immich (possible values are: preview / original).	preview
image_excludes	List of regular expressions for excluding files and directories from local media sources. See below for details.	[]
image_fit	Value to be used for the CSS-property 'object-fit' of the images (possible values are: cover / contain / fill / ...).	cover
image_background	If set to image, the current image is also displayed as the background over the entire screen. Use the wallpanel-screensaver-image-background class to style the background.	color
image_list_update_interval	When using a local media source, the image list is updated at this interval.	3600
image_order	The order in which the images are displayed (possible values are: sorted / random).	sorted
image_animation_ken_burns	Apply a Ken Burns effect (panning and zooming) to the images?	false
image_animation_ken_burns_zoom	Zoom level for the Ken Burns effect.	1.3
image_animation_ken_burns_delay	Start Ken Burns effect with a delay (in seconds).	0
show_image_info	Show image info (EXIF / API) on top of image? Only available for local jpeg images containing EXIF data and images from the new Unsplash API. The config name was show_exif_info before version 4.7.	false
show_progress_bar	Show animated progress bar towards next image being displayed?	false
fetch_address_data	Fetch address data for EXIF GPS coordinates from nominatim.openstreetmap.org?	false
image_info_template	Format of image info display (HTML). ${EXIF-tag-name} will be replaced with the corresponding EXIF tag value. The config name was exif_info_template before version 4.7.	${DateTimeOriginal}
touch_zone_size_next_image	Size of the area on the right side of the screen at which a click will show the next image (as a percentage of the total screen width, 0 = disabled).	15
touch_zone_size_previous_image	Size of the area on the left side of the screen at which a click will show the previous image (as a percentage of the total screen width, 0 = disabled).	15
info_animation_duration_x	Animation duration in seconds for the movement of the info box in x-direction (0 = no animation).	0
info_animation_duration_y	Animation duration in seconds for the movement of the info box in y-direction (0 = no animation).	0
info_animation_timing_function_x	The CSS timing-function to use for the animation of the info box movement in x-direction.	ease
info_animation_timing_function_y	The CSS timing-function to use for the animation of the info box movement in y-direction.	ease
info_move_pattern	Movement pattern of the info box at a specified interval (possible values are: random / corners).	random
info_move_interval	Interval of movement of the info box in seconds (0 = no movement).	0
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
style	Additional CSS styles for wallpanel elements.	{}
badges	Badges to display in info box. Set to [] to show no badges at all. See below for details.	[]
cards	Cards to display in info box. Set to [] to show no cards at all. See below for details.	See below
card_interaction	Allow interaction with the cards displayed in the info box?	false
profiles	Configuration profiles. See below for details.	{}
profile	Configuration profile to activate. If browser_mod is installed, ${browser_id} will be replaced with Browser ID (see below).
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 below).
camera_motion_detection_enabled	Activate camera based motion detection? Screensaver is stopped when movement is detected.	false
camera_motion_detection_threshold	If this many percent of the pixels change between two images, this is counted as movement.	5
camera_motion_detection_capture_width	Width of the images captured by the camera in pixels.	64
camera_motion_detection_capture_height	Height of the images captured by the camera in pixels.	48
camera_motion_detection_capture_interval	Interval in seconds at which images are captured by the camera.	0.3
camera_motion_detection_capture_visible	Should the captured images be displayed on the user interface for debugging?	false

Home Assistant Dashboard configuration

You can add the configuration to your Home Assistant Dashboard configuration yaml (raw config).

• Click Overview in your sidebar.
• Click the three dots menu (top-right) and click on Edit Dashboard.
• Click the three dots menu again and click on Raw configuration editor.
• Add the wallpanel configuration above anything else.

Short example:

wallpanel:
  enabled: true
  hide_toolbar: true
  hide_sidebar: true
  fullscreen: true

Extended example:

wallpanel:
  enabled: true
  enabled_on_tabs:
    - default_view
  debug: false
  hide_toolbar: true
  hide_sidebar: true
  fullscreen: true
  idle_time: 10
  keep_screen_on_time: 86400
  black_screen_after_time: 7200
  control_reactivation_time: 1.0
  screensaver_stop_navigation_path: /lovelace/default_view
  image_url: 'http://picsum.photos/${width}/${height}?random=${timestamp}'
  image_fit: cover
  image_list_update_interval: 3600
  image_order: 'sorted'
  image_excludes: []
  show_image_info: false
  fetch_address_data: true
  image_info_template: '${address.town|address.city!prefix=!suffix= // }${DateTimeOriginal!options=year:numeric,month:long}'
  screensaver_entity: input_boolean.wallpanel_screensaver
  info_animation_duration_x: 30
  info_animation_duration_y: 11
  info_animation_timing_function_x: 'ease-in-out'
  info_animation_timing_function_y: 'ease-in-out'
  info_move_pattern: random
  info_move_interval: 0
  info_move_fade_duration: 2.0
  card_interaction: true
  style:
    wallpanel-screensaver-info-box:
      font-size: 8vh
      font-weight: 600
      color: '#eeeeee'
      text-shadow: '-2px -2px 0 #03a9f4, 2px -2px 0 #03a9f4, -2px 2px 0 #03a9f4, 2px 2px 0 #03a9f4'

URL query parameters

It is also possible to pass configuration parameters in the query string. These parameters (wp_<parameter>) will override the corresponding properties in the yaml configuration. Use JSON syntax for the values.

Example: http://hass:8123/lovelace/default_view?wp_hide_sidebar=false

Note: Please note that the URL parameters may be lost when navigating in the Home Assistant interface. Therefore, this option should not normally be used.

Activate on individual devices only

• Install Browser Mod.
• Set enabled to false and add a device-specific profile to enable the wallpanel only on the device in your dashboard configuration:

wallpanel:
  enabled: false
  profiles:
    device.<browser-id>:
      enabled: true

Example for Browser-ID e9a2c86e-5526f1ee:

wallpanel:
  enabled: false
  profiles:
    device.e9a2c86e_5526f1ee:
      enabled: true

For more details see section Integration with browser_mod.

image_url

Screensaver images will be fetched from this URL. This can be any HTTP URL, a Home Assistant media-source URL or a Home Assistant entity that has the entity_picture attribute.

Tip: If you click on the far right side of the screen while the screen saver is active, the next image will be displayed. A click on the left side shows the previous picture and reverses the playback order.

HTTP URL

The default value is: http://picsum.photos/${width}/${height}?random=${timestamp}

The following variables can be used in HTTP URLs:

• ${timestamp} = current unix timestamp
• ${width} = viewport width
• ${height} = viewport height

Example of using images from unsplash.com (old api):

https://source.unsplash.com/random/${width}x${height}?sig=${timestamp}

You can narrow down the images from unsplash.com using certain search terms, for example "fruit" and "beer".

https://source.unsplash.com/random/${width}x${height}?fruit,beer&sig=${timestamp}

Example of using images from api.unsplash.com (new api):

image_order: random
image_list_update_interval: 3600
image_url: https://api.unsplash.com/photos/random?client_id=YOUR_ACCESS_KEY&query=dogs
show_image_info: true
image_info_template: '<span style="color:#990000">//</span> ${description|alt_description}'

See Unsplash API documentation (Get a random photo) for details.

Media-source URL

It is also possible to use images from the Home Assistant Local Media source. See Home Assistant Media Source integration documentation for details.

If you are not sure which is the correct media source URL, you can proceed as follows:

1. navigate to the folder you want to use in the HA Media Browser
2. copy the displayed browser URL and decode it with a URL decoder tool. For example, you can use www.urldecoder.org.
3. copy the part of the decoded URL after the last comma (,) that begins with media-source://.

Instead of using media-source://media_source/ as image_url you can just use / as a shortcut.

• / = Images in all Local Media sources
• /media1 = Images in the Local Media directory named media1
• /media1/folder1 = Images in folder1 of the Local Media directory named media1

If you are using the Synology DSM integration, and want to use an Photo album from there you can use:

source://synology_dsm/<unique_id>/<album_id>

<unique_id> is the Home Assistant ID for the NAS (usually the serial number of the NAS).

For example:

media-source://synology_dsm/18C0PEN253705/19

immich API (experimental)

There is experimental support for retrieving images from an immich server.

immich server CORS

You must configure the immich server so that it accepts API calls from external domains (CORS). Depending on your web server, the configuration will be different.

Here is a configuration example for nginx:

if ($request_method = 'OPTIONS') {
  add_header 'Access-Control-Allow-Origin' '*' always;
  add_header 'Access-Control-Allow-Methods' 'GET, PUT, POST, DELETE, OPTIONS' always;
  add_header 'Access-Control-Allow-Headers' 'X-Api-Key, User-Agent, Content-Type' always;
  add_header 'Access-Control-Max-Age' 1728000;
  add_header 'Content-Type' 'text/plain charset=UTF-8';
  add_header 'Content-Length' 0;
  return 204;
}

For Traefik, you can use:

traefik.http.middlewares.immich-cors.headers.accessControlAllowOriginList=*
traefik.http.middlewares.immich-cors.headers.accessControlAllowMethods=GET, PUT, POST, DELETE, OPTIONS
traefik.http.middlewares.immich-cors.headers.accessControlAllowHeaders=X-Api-Key, User-Agent, Content-Type
traefik.http.middlewares.immich-cors.headers.accessControlMaxAge=1728000
traefik.http.routers.immich.middlewares=immich-cors

Note: You should prefer to use a list of URLs in Access-Control-Allow-Origin instead of using *.

Wallpanel configuration

To access the immich API, first generate an API key.

Then you can configure wallpanel to use the immich API. You need to set the image_url to immich+<your api url> and enter the API key in immich_api_key. To restrict the images to be retrieved to specific albums, you can configure a list of album names in immich_album_names.

Example:

image_url: immich+https://immich.your.domain/api
immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
immich_album_names:
  - Tokio
  - New York

Entity with entity_picture attribute

When an entity has the entity_picture attribute you can use the image to be shown when the screensaver starts. If the image is dynamic, for example when using a camera entity, the image will change when the entity_picture resolves to a changed image. You can control how often the the image is checked by adjusting the display_time settting. To use an entity as source for images, set the image_url setting to media-entity://<entity_id>.

Example:

display_time: 15
image_url: media-entity://camera.my_camera_entity_id

With the entity_picture you can combine this integration with the Google Photos Integration extension from Daanoz to display your photos.

Example:

image_url: media-entity://camera.google_photos_favorites_media

See Google Photos Integration README for details.

image_excludes

A list of regular expressions which can be used to exclude files and directories from local media sources.

Example

image_excludes:
  - '\.tif$'
  - '/@eaDir'

Image info

Set show_image_info to true to show info on top of images if available. This will only work for local jpeg images.

The image info can be formatted by specifying HTML code in image_info_template. Placeholders like ${EXIF-tag-name} will be replaced with the corresponding EXIF tag value. See exif.js for available EXIF tag names.

If the EXIF data contains GPS location information and the fetch_address_data configuration is set to true, address data for the GPS coordinates will be fetched from nominatim.openstreetmap.org. The received address data can be used via placeholders in the form address.<attribute>. Available attributes are: country, country_code, county, municipality, postcode, region, road, state, city, town and village. See Nominatim Reverse Geocoding for details. Please respect the Nominatim Usage Policy.

If you specify multiple alternative values separated by a pipe symbol (|), the first available attribute is used.

A prefix and suffix string can be added for each placeholder. Prefix and suffix are not displayed if the placeholder value is empty.

For date values you can specify date format options. Each option must consist of an <option name>:<option value> pair. Multiple options must be separated by commas. Available option names are: year, month, day, weekday, hour, minute and second. Possible option values are: long, short, narrow, numeric and 2-digit. See toLocaleDateString options for details.

The image.relativePath placeholder is replaced with the pathname to the current image, relative to the image_url configuration parameter. image.url is the complete URL of the image, while image.path is the image path. image.folderName contains the name of the parent folder.

Examples

Display location and date

show_image_info: true
image_info_template: '<span style="color:#990000">//</span> ${address.town|address.city|address.municipality!prefix=!suffix= // }${DateTimeOriginal!options=year:numeric,month:long,day:2-digit}'

Display image path

show_image_info: true
image_info_template: >-
    <span style="font-family: 'Roboto Condensed', sans-serif; font-size: 1em; font-weight: 400; color: #999;">
      ${image.relativePath}
    </span>

The CSS class wallpanel-screensaver-image-info can be used to style the image info. See section "Styles".

Badges and cards

A so-called info box can be displayed above the images. You can add badges and cards to this box.

You can use the same yaml config, as used in the Home Assistant Dashboard configuration (raw config).

Example (and default) for cards:

wallpanel:
  cards:
    - type: weather-forecast
      entity: weather.home
      show_forecast: true
      forecast_type: daily

If you want to interact with the cards, as in the dashboard, you can set card_interaction to true.

wallpanel:
  card_interaction: true

Example for badges:

wallpanel:
  badges:
    - entity: person.somebody
    - entity: sun.sun

Info box animation

The info box, which contains the cards and badges, can be animated and moved around the screen using CSS animations. The following settings can be used to configure the animation:

info_animation_duration_x: How long it will take in seconds to move the info box from one end of the screen to the other in x-direction. If set to 0, animation in x-direction will be disabled.

info_animation_duration_y: Same as above, but in y-direction.

The style of the animation can be configured with info_animation_timing_function_x for x-direction and info_animation_timing_function_y for the y-direction using a CSS animation-timing-function.

Possible values are, for example, ease and linear. For details, please have a look at MDN - CSS animation-timing-function.

An example of a nice animated movement using the Easing function:

info_animation_duration_x: 30
info_animation_duration_y: 13
info_animation_timing_function_x: ease-in-out
info_animation_timing_function_y: ease-in-out

Be aware that animations increase CPU/GPU usage and power consumption.

A timing function that requires few resources is the step function (steps(<number-of-steps> [, <step-position> ])). You can play with the number of steps to achieve the desired result. Here is one example in combination with duration settings:

info_animation_duration_x: 10
info_animation_duration_y: 20
info_animation_timing_function_x: steps(3, end)
info_animation_timing_function_y: steps(3, end)

Fewer steps and higher duration will result in fewer movements and lower resource consumption.

In addition, it is possible to move the info box to a random position on the screen or around corners of the screen (ie. top left, bottom left, bottom right, top right, and so forth), at a fixed time interval.

Example

info_move_pattern: random
info_move_interval: 10
info_move_fade_duration: 2.0

keep_screen_on_time

If you set this attribute to a value greater than zero, the screen is prevented from dimming or locking for the specified time in seconds.

If supported by the browser, this is done via the Screen Wake Lock API. The Screen Wake Lock API is usually only available when provided over HTTPS.

If the screen lock API is not available, a short invisible video is played in a loop instead to keep the screen on. Due to browser limitations, you must interact with the screen once to enable the screen lock after the Dashboard page loads.

screensaver_entity

You can create an input_boolean helper in HA and set screensaver_entity to this entity id. When the screensaver starts this input_boolean will be set to on and to off when the screensaver stops. It is also possible to start and stop the screensaver by changing this input_boolean.

Styles

You can customize the style of every wallpanel element.

The most important element IDs are:

• wallpanel-screensaver-container
• wallpanel-screensaver-info-box
• wallpanel-screensaver-info-box-content
• wallpanel-screensaver-info-box-badges
• wallpanel-screensaver-image-background
• wallpanel-screensaver-image-info
• wallpanel-screensaver-image-overlay
• wallpanel-screensaver-overlay

Use the style configuration attribute and add a key for the element ID for which you want to set style attributes.

Example

style:
  wallpanel-screensaver-overlay:
    background: '#00000055'
  wallpanel-screensaver-info-box-content:
    background: '#ffffff'

The following CSS custom properties (variables) can be used to set styles for all added cards, the defaults are:

style:
  wallpanel-screensaver-info-box:
    '--wp-card-width': 500px
    '--wp-card-margin': 5px
    '--wp-card-padding': 0px
    '--wp-card-backdrop-filter': none

You can add the wp_style attribute for individual cards and badges to set CSS styles as needed.

Example

cards:
  - type: weather-forecast
    entity: weather.home
    wp_style:
      margin-top: 10px
      '--ha-card-background': '#990000'

The CSS class wallpanel-screensaver-image-info can be used to style the image info layer.

Example and default:

style:
  wallpanel-screensaver-image-info:
    position: 'absolute'
    bottom: '0.5em'
    right: '0.5em'
    padding: '0.1em 0.5em 0.1em 0.5em'
    font-size: '2em'
    background: '#00000055'
    backdrop-filter: 'blur(2px)'
    border-radius: '0.1em'

Another example:

style:
  wallpanel-screensaver-image-info:
    position: 'absolute'
    bottom: '0.5em'
    right: '1.0em'
    font-size: '2.5em'
    -webkit-text-stroke: '0.02em #000'
    color: '#ff9a00'
    font-weight: '900'
    font-family: 'monospace'

Here are some style examples:

Dark style

style:
  wallpanel-screensaver-info-box:
    '--wp-card-width': 450px
    background-color: '#00000099'
    box-shadow: 0px 2px 1px -1px rgba(0, 0, 0, 0.2), 0px 1px 1px 0px rgba(0, 0, 0, 0.14), 0px 1px 3px 0px rgba(0, 0, 0, 0.12)
  wallpanel-screensaver-info-box-content:
    '--ha-card-background': none
    '--ha-card-box-shadow': none
    '--ha-card-border-width': 0px
    '--primary-background-color': '#111111'
    '--secondary-background-color': '#202020'
    '--primary-text-color': '#e1e1e1'
    '--secondary-text-color': '#9b9b9b'

Light style

style:
  wallpanel-screensaver-container:
    background-color: '#333333dd'
  wallpanel-screensaver-info-box:
    '--wp-card-width': 450px
    background-color: '#ffffff99'
    box-shadow: 0px 2px 1px -1px rgba(0, 0, 0, 0.2), 0px 1px 1px 0px rgba(0, 0, 0, 0.14), 0px 1px 3px 0px rgba(0, 0, 0, 0.12)
  wallpanel-screensaver-info-box-content:
    '--ha-card-background': none
    '--ha-card-box-shadow': none
    '--ha-card-border-width': 0px
    '--primary-background-color': '#fafafa'
    '--secondary-background-color': '#e5e5e5'
    '--primary-text-color': '#212121'
    '--secondary-text-color': '#727272'

Transparent style

style:
  wallpanel-screensaver-info-box:
    '--wp-card-width': 450px
  wallpanel-screensaver-info-box-content:
    '--ha-card-background': none
    '--ha-card-box-shadow': none
    '--ha-card-border-width': 0px
    text-shadow: -0.5px -0.5px 0 rgb(17, 17, 17), 0.5px -0.5px 0 rgb(17, 17, 17), -0.5px 0.5px 0 rgb(17, 17, 17), 0.5px 0.5px 0 rgb(17, 17, 17)
    '--primary-text-color': '#ffffff'
    '--secondary-text-color': '#dddddd'

Alternative transparent style with text shadow

style:
  wallpanel-screensaver-info-box-content:
    '--ha-card-background': none
    '--ha-card-box-shadow': none
    '--ha-card-border-width': 0px
    '--primary-text-color': '#ffffff'
    '--secondary-text-color': '#dddddd'
    filter: 'drop-shadow(0px 0px 3px rgb(17, 17, 17)) drop-shadow(0px 0px 8px rgb(30, 30, 30))'

Positioning

The cards and badges are positionend by a Grid_Layout.

Example

  cards:
    - type: markdown
      content: Card 1
      wp_style:
        width: 810px
        grid-row: 1
        grid-column: 1 / span 2
    - type: markdown
      content: Card 2
      wp_style:
        width: 400px
        grid-row: 2
        grid-column: 2
    - type: markdown
      content: Card 3
      wp_style:
        width: 400px
        grid-row: 3
        grid-column: 1
    - type: markdown
      content: Card 4
      wp_style:
        width: 400px
        grid-row: 3
        grid-column: 2

Dynamic configuration using entities

The wallpanel configuration can be changed dynamically by using input_text or input_select helpers. Placeholders can be used in the yaml configuration, which are replaced by the state value of the corresponding entity. These placeholders have the form ${entity:<entity-id>}, where <entity-id> must be replaced by the ID of an existing HA entity. Whenever the state of such an entity changes, the configuration is updated immediately.

For the example, an input_select helper named wallpanel_image_url must be created in HA. The enity ID of the helper will be input_select.wallpanel_image_url by default. A placeholder can now be inserted in the yaml configuration:

wallpanel:
  image_url: '${entity:input_select.wallpanel_image_url}'

Whenever the state of the entity is changed manually or by automation, the configuration is updated accordingly.

It is also possible to dynamically change only a part of the configuration value:

wallpanel:
  image_url: 'https://api.unsplash.com/photos/random?client_id=YOUR_ACCESS_KEY&query=${entity:input_text.wallpanel_unsplash_query}'

Profiles

With profiles you can easily switch between different configurations. The profiles definition is added at the end of the wallpanel definition. everything before this section represents the 'standard' or default profile.

Example

wallpanel:
  enabled: true
  info_animation_duration_x: 30
  info_animation_duration_y: 20
  style:
    wallpanel-screensaver-overlay:
      background: '#00000000'
  profiles:
    night:
      info_animation_duration_x: 0
      info_animation_duration_y: 0
      style:
        wallpanel-screensaver-overlay:
          background: '#000000bb'
    black:
      black_screen_after_time: 1
    user.jane:
      enabled: false
  profile: night
  profile_entity: input_text.wallpanel_profile

The example contains three (additional) profiles night, black and user.jane. Setting the profile configuration to a profile name will overwrite the main (default) configuration with the settings defined in the referenced profile.

There are three different options to activate a profile:

A) Activation by a query string parameter: http://hass:8123/lovelace/default_view?wp_profile="night"

B) Dynamically activation by using an input_text or input_select helper. For the example, an input_text helper named wallpanel_profile must be created in HA. The profile can then be changed by setting the status of input_text.wallpanel_profile either manually or by an (e.g. time based) automation. Changing the value of the helper to the (exact) name of the profile will change the display immediately. Any value different to the defined additional profiles will switch back to the default/standard definitions

C) Adding the line profile: (name) to the profile section (second last line in example) however this may be useful in rare situations only

D) An existing user profile is automatically activated if it matches the logged-in user. The name of a user profile must start with the string user. followed by a user name. The username of the logged in user is converted to lowercase and spaces are replaced with _. Therefore, the username Jane Doe will activate the user profile user.jane_doe.

Integration with browser_mod

Normally, it is not possible to set different configuration for different devices. That gap can be closed by integrating WallPanel with Browser Mod.

Once Browser Mod is correctly installed and configured, Browser ID can be used to define per-device settings. The placeholders ${browser_id} kann be used everywhere in the configuration and will be replaced by the Browser ID. Minus signs in the browser ID are replaced by underscores.

A separate profile can be defined for each device:

wallpanel:
  enabled: true
  image_order: random
  profiles:
    device.e9a2c86e_5526f1ee:
      image_url: media-source://media_source/local/kitchen
      screensaver_entity: input_boolean.screensaver_kitchen
    device.89ae788b_cd883eb1:
      image_url: media-source://media_source/local/livingroom
      screensaver_entity: input_boolean.screensaver_livingroom

Note: It is not required to define profiles for all devices.

If only individual configuration attributes are to be device-specific, this can be achieved by using the placeholder without having to create an entire profile for the device.

For example, a separate screensaver entity for each device:

wallpanel:
  enabled: true
  screensaver_entity: input_boolean.screensaver_${browser_id}

${browser_id} will be replaced with the value of Browser ID (eg. input_boolean.screensaver_e9a2c86e_5526f1ee).

A device-specific profile entity for each device:

wallpanel:
  enabled: true
  profiles:
    dogs:
      image_url: https://source.unsplash.com/random/${width}x${height}?dogs&sig=${timestamp}
    cats:
      image_url: https://source.unsplash.com/random/${width}x${height}?cats&sig=${timestamp}
  profile_entity: input_text.screensaver_profile_${browser_id}

You can stop the screensaver with the javascript code below from a browser mod service.

document.querySelector("home-assistant").shadowRoot.querySelector("home-assistant-main").shadowRoot.querySelector("wallpanel-view").stopScreensaver();

disable_screensaver_on_browser_mod_popup_func

You can use this option to conditionally disable the screensaver based on the active browser mod popup. Use the variable bmp to select the popup element.

As an example, this javascript will only disable the screensaver if the active browser mod popup contains a webrtc-camera card:

disable_screensaver_on_browser_mod_popup_func: |
  let elements = bmp.shadowRoot.querySelector(".container").children;
  return Array.from(elements).some(n => n.nodeName.toLowerCase() === "webrtc-camera");

FAQ - Frequently Asked Questions

Dashboard cannot be edited

After hiding the toolbar, I can no longer edit the dashboard. How can I recover?

If you add ?edit=1 or ?wp_enabled=false to the URL in the browser, wallpanel will not be active, so the toolbar will not be hidden either. You can also use ?wp_hide_toolbar=false to only change this setting.

Example: http://192.168.1.1:8123/lovelace/default_view?wp_enabled=false

Debug mode

If debug mode is enabled, an overlay is displayed in which status information is shown. There is a button to download a log file that contains information to help analyze problems. The debug mode can be activated and deactivated via the configuration. You can also turn debug mode on and off by triple-clicking in the lower middle part of the screen while the screen saver is active.

Credits

Thanks to Unsplash and to all the photographers for sharing their great photos! Many thanks to Openstreetmap for providing the excellent Nominatim search engine! Thanks to Jacob Seidelin for exif-js!

This project is inspired by:

• https://github.com/tcarlsen/lovelace-screensaver
• https://gist.github.com/ciotlosm/1f09b330aa5bd5ea87b59f33609cc931
• https://github.com/richtr/NoSleep.js
• https://github.com/madeInLagny/mil-no-sleep

Additional Resources

If you need more assistance on the topic, please have a look at the following external resources:

Reviews / Tutorials

• SmartHomeScene - WallPanel: Home Assistant Screensaver for your wall-mounted control panel
• Smart Home Pursuites - Install Fully-Kiosk + Wallpanel in Home Assistant for Fire Tablets

Videos

YouTube-Video on "Next Level Tablet Dashboard 🌅 mit lovelace-wallpanel 🤩" (🇩🇪)

YouTube-Video on "So wird dein Home Assistant Wallpanel zum Kunstobjekt!" (🇩🇪)

https://www.youtube.com/watch?v=ohBRmoOTKW0