Skip to content

This HA addon generates a png from a Home Assistant Lovelace view, which can be displayed on a Kindle device which has the Online Screensaver plugin installed.

License

Notifications You must be signed in to change notification settings

wendevlin/hass-lovelace-kindle-screensaver

 
 

Repository files navigation

Changes

This is fork of https://github.com/marciogranzotto/hass-lovelace-kindle-screensaver (original repository transfered to hassio add-on) merged with https://github.com/itobey/hass-lovelace-screenshotter (becuase it contains changes to inkplate 10). Thanks to both authors for their amazing work!


Home Assistant Lovelace dashboard renderer

ci

This tool can be used as Home Assistant addon to display a Lovelace view of your Home Assistant instance as an image. So it can be displayed on the eink panel or any screen connected to the network. It regularly takes a screenshot which can be polled.

Sample image

Sample image

Features

This tool regularly takes a screenshot of a specific page of your home assistant setup. It converts it into the PNG with various options (color or grayscale).

Usage

Go to the Home Assistant options, addons, addon store, then using upper right menu add this as an repository. Then you should be able to install the addon using the install button on this page.

After instaling go to the addon config and (minimally) setup two options:

  • ha_base_url - base url of your home assistant instance (http://192.168.0.2:8123 for example)
  • ha_access_token - go to your user profile and the bottom you will have an option to generate access token. Paste it there.

You can access the image by doing a simple GET request to e.g. http://localhost:5000/ to receive the most recent image.

All options are the same as original addon and are listed below:

Env Var Sample value Required Array?* Description
ha_base_ulr https://your-hass-instance.com:8123 yes no Base URL of your home assistant instance
ha_screenshot_url /lovelace?kiosk no yes Relative URL to take screenshot of (btw, the ?kiosk parameter hides the nav bar using the kiosk mode project)
ha_access_token eyJ0... yes no Long-lived access token from Home Assistant, see official docs
language en no no Language to set in browser and home assistant
cron_job * * * * * no no How often to take screenshot
rendering_timeout 10000 no no Timeout of render process, helpful if your HASS instance might be down
rendering_delay 0 no yes how long to wait between navigating to the page and taking the screenshot, in milliseconds
rendering_screen_width 800 no yes Height of your kindle screen resolution
rendering_screen_width 600 no yes Width of your kindle screen resolution
rotation 0 no yes Rotation of image in degrees, e.g. use 90 or 270 to render in landscape
scaling 1 no yes Scaling factor, e.g. 1.5 to zoom in or 0.75 to zoom out
grayscale_depth 8 no yes Ggrayscale bit depth your kindle supports
color_mode GrayScale no yes ColorMode to use, ex: GrayScale, or TrueColor.
diter false no yes Apply a dither to the images.

* Array mode of original addon are not currently supported.

Advanced configuration

You can change the port used by the addon using the configuration screen.

About

This HA addon generates a png from a Home Assistant Lovelace view, which can be displayed on a Kindle device which has the Online Screensaver plugin installed.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 79.2%
  • Dockerfile 20.8%