Update from base repo

.dockerignore

@@ -1,6 +1,13 @@
 node_modules/
+.github/
+.git/
 .vscode/
 assets/
 config.*.js
 docker-compose.*.yml
-output/
+docker-compose.yml
+output/
+LICENSE
+*.md
+*.yml
+*.yaml

.github/workflows/ci.yml

@@ -2,34 +2,66 @@ name: ci
 
 on:
   push:
-    branches: main
+    tags: [ 'v*.*.*' ]
 
 jobs:
   multi:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Set up QEMU
+      - name: Extract package version
+        run: node -p -e '`PACKAGE_VERSION=${require("./package.json").version}`' >> $GITHUB_ENV
+      - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
-      -
-        name: Set up Docker Buildx
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
-      -
-        name: Login to DockerHub
-        uses: docker/login-action@v1 
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Build and push
+      - name: Build and push to Docker
         uses: docker/build-push-action@v2
         with:
           context: .
           file: ./Dockerfile
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: true
           tags: |
+            sibbl/hass-lovelace-kindle-screensaver:${{ env.PACKAGE_VERSION }},
             sibbl/hass-lovelace-kindle-screensaver:latest
+      - name: Build and push HA_Addon AMD64 to Docker
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile.HA_ADDON
+          build-args: BUILD_FROM=homeassistant/amd64-base:latest
+          platforms: linux/amd64
+          push: true
+          tags: |
+            sibbl/hass-lovelace-kindle-screensaver-ha-addon-amd64:${{ env.PACKAGE_VERSION }},
+            sibbl/hass-lovelace-kindle-screensaver-ha-addon-amd64:latest
+      - name: Build and push HA_Addon aarch64 to Docker
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile.HA_ADDON
+          build-args: BUILD_FROM=homeassistant/aarch64-base:latest
+          platforms: linux/arm64/v8
+          push: true
+          tags: |
+            sibbl/hass-lovelace-kindle-screensaver-ha-addon-aarch64:${{ env.PACKAGE_VERSION }},
+            sibbl/hass-lovelace-kindle-screensaver-ha-addon-aarch64:latest
+
+      - name: Build and push HA_Addon ARMv7 to Docker
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile.HA_ADDON
+          build-args: BUILD_FROM=homeassistant/armv7-base:latest
+          platforms: linux/arm/v7
+          push: true
+          tags: |
+            sibbl/hass-lovelace-kindle-screensaver-ha-addon-armv7:${{ env.PACKAGE_VERSION }},
+            sibbl/hass-lovelace-kindle-screensaver-ha-addon-armv7:latest

.gitignore

@@ -3,4 +3,5 @@ node_modules/
 config.*.js
 docker-compose.*.yml
 cover.png
-output/
+.devcontainer/
+.DS_Store

CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+## 1.0.13
+
+### Added
+
+* Allow configuring contrast, saturation, black level and white level. JPEG quality is set to 100% (thanks to [@harry48225](https://github.com/harry48225))
+
+## 1.0.12
+
+### Fixed
+
+* Fix scaling bug by using zoom css property instead of transforms (thanks to [@avhm](https://github.com/avhm))
+
+## 1.0.11
+
+### Fixed
+
+* Avoid viewport resize causing another rerender when taking screenshot (thanks to [@beeh5](https://github.com/beeh5))
+
+## 1.0.10
+
+### Fixed
+
+* Fix REMOVE_GAMMA and DITHER always being enabled for Home Assistant Add-On
+
+## 1.0.9
+
+### Added
+
+* Add jpeg support via new `IMAGE_TYPE` config env variable (thanks to [@nbarrientos](https://github.com/nbarrientos))
+
+## 1.0.8
+
+### Fixed
+
+* Remove DITHER option from Home Assistant Add-On again until the gm/im incompatibility will be fixed
+
+## 1.0.7
+
+### Added
+
+* Finally there's a changelog
+* Allow custom environment variables to Home Assistant Add-On
+
+### Fixed
+
+* Add missing config variables to Home Assistant Add-On

Dockerfile

@@ -1,11 +1,12 @@
-FROM node:12-alpine
+FROM node:16-alpine3.17
 
 WORKDIR /app
 
 RUN apk add --no-cache \
     chromium \
     nss \
-    freetype \
+    freetype \    
+    font-noto-emoji \
     freetype-dev \
     harfbuzz \
     ca-certificates \
@@ -17,10 +18,11 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
     USE_IMAGE_MAGICK=true
 
 COPY package*.json ./
+COPY local.conf /etc/fonts/local.conf
 
 RUN npm ci
 
-COPY . . 
+COPY *.js ./
 
 EXPOSE 5000
 

Dockerfile.HA_ADDON

@@ -0,0 +1,33 @@
+ARG BUILD_FROM
+FROM ${BUILD_FROM} 
+
+WORKDIR /app
+RUN apk add --no-cache \
+    chromium \
+    nss \
+    freetype \
+    font-noto-emoji \
+    freetype-dev \
+    harfbuzz \
+    ca-certificates \
+    ttf-freefont \
+    imagemagick \
+    nodejs \
+    npm
+
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
+    PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser \
+    USE_IMAGE_MAGICK=true
+
+COPY package*.json ./
+COPY local.conf /etc/fonts/local.conf
+COPY *.js ./
+
+RUN npm ci
+
+
+# Copy data for add-on
+COPY run.sh /
+RUN chmod a+x /run.sh
+
+CMD [ "/run.sh" ]

README.md

@@ -12,36 +12,109 @@ If you're looking for a way to render your own HTML, see my other project [hass-
 
 ## Features
 
-This tool regularly takes a screenshot of a specific page of your home assistant setup. It converts it into the PNG grayscale format which Kindles can display.
+This tool regularly takes a screenshot of a specific page of your home assistant setup. It converts it into the PNG/JPEG grayscale format which Kindles can display.
 
 Using my [own Kindle 4 setup guide](https://github.com/sibbl/hass-lovelace-kindle-4) or the [online screensaver extension](https://www.mobileread.com/forums/showthread.php?t=236104) for any jailbroken Kindle, this image can be regularly polled from your device so you can use it as a weather station, a display for next public transport departures etc.
 
 ## Usage
 
-You may simple set up the [sibbl/hass-lovelace-kindle-screensaver](https://hub.docker.com/r/sibbl/hass-lovelace-kindle-screensaver) docker container. The container exposes a single port (5000 by default). You can access the image by doing a simple GET request to e.g. `http://localhost:5000/` to receive the most recent image.
+You may simple set up the [sibbl/hass-lovelace-kindle-screensaver](https://hub.docker.com/r/sibbl/hass-lovelace-kindle-screensaver) docker container. The container exposes a single port (5000 by default).
 
-Home Assistant related stuff:
-
-- `HA_BASE_URL=https://your-hass-instance.com:8123`
-- `HA_SCREENSHOT_URL=/lovelace/screensaver?kiosk` (I recommend the [kiosk mode](https://github.com/maykar/kiosk-mode) project)
-- `HA_ACCESS_TOKEN=eyJ0...` (you need to create this token in Home Assistant first)
-- `LANGUAGE=en` (language to use in Home Assistant frontend)
-- `CRON_JOB=* * * * *` (how often to take screenshots, by default every minute)
+Another way is to use Hassio Addons where you have to add this repository or click [here](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fsibbl%2Fhass-lovelace-kindle-screensaver). Then Reload and you should see options to the Lovelace Kindle Screensaver Addon
 
-Kindle related stuff:
+I recommend simply using the `docker-compose.yml` file inside this repository, configure everything in there and run `docker-compose up -d` within the file's directory. This will pull the docker image, create the container with all environment variables from the file and run it in detached mode (using `-d`, so it continues running even when you exit your shell/bash/ssh connection).
+Additionally, you can then later use `docker-compose pull && docker-compose up -d` to update the image in case you want to update it.
 
-- `RENDERING_TIMEOUT=10000` (timeout of render process, necessary if your HASS instance might be down, in milliseconds)
-- `RENDERING_DELAY=0` (how long to wait between navigating to the page and taking the screenshot, in milliseconds)
-- `RENDERING_SCREEN_HEIGHT=800` (height of your kindle screen resolution, see below)
-- `RENDERING_SCREEN_WIDTH=600` (width of your kindle screen resolution, see below)
-- `ROTATION=0` (rotation of image in degrees, i.e. use 90 or 270 to render in landscape)
-- `SCALING=1` (scaling factor, i.e. 1.5 to zoom in or 0.75 to zoom out)
-- `GRAYSCALE_DEPTH=8` (grayscale bit depth your kindle supports)
+You can then access the image by doing a simple GET request to e.g. `http://localhost:5000/` to receive the most recent image (might take up to 60s after the first run).
 
-Advanced stuff:
+Home Assistant related stuff:
 
-- `OUTPUT_PATH=./output.png` (destination of rendered image)
+| Env Var                   | Sample value                          | Required | Array?\* | Description                                                                                                                                                                                          |
+|---------------------------|---------------------------------------| -------- | -------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `HA_BASE_URL`             | `https://your-hass-instance.com:8123` | yes      | no       | Base URL of your home assistant instance                                                                                                                                                             |
+| `HA_SCREENSHOT_URL`       | `/lovelace/screensaver?kiosk`         | yes      | yes      | Relative URL to take screenshot of (btw, the `?kiosk` parameter hides the nav bar using the [kiosk mode](https://github.com/NemesisRE/kiosk-mode) project)                                           |
+| `HA_ACCESS_TOKEN`         | `eyJ0...`                             | yes      | no       | Long-lived access token from Home Assistant, see [official docs](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token)                                                        |
+| `HA_BATTERY_WEBHOOK`      | `set_kindle_battery_level`            | no       | yes      | Webhook definied in HA which receives `batteryLevel` (number between 0-100) and `isCharging` (boolean) as JSON                                                                                       |
+| `LANGUAGE`                | `en`                                  | no       | no       | Language to set in browser and home assistant                                                                                                                                                        |
+| `PREFERS_COLOR_SCHEME`    | `light`                               | no       | no       | Enable browser dark mode, use `light` or `dark`.                                                                                                                                                     |
+| `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_HEIGHT` | `800`                                 | no       | yes      | Height of your kindle screen resolution                                                                                                                                                              |
+| `RENDERING_SCREEN_WIDTH`  | `600`                                 | no       | yes      | Width of your kindle screen resolution                                                                                                                                                               |
+| `BROWSER_LAUNCH_TIMEOUT`  | `30000`                               | no       | no       | Timeout for browser launch, helpful if your HASS instance is slow                                                                                                                                    |
+| `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      | Grayscale bit depth your kindle supports                                                                                                                                                             |
+| `COLOR_MODE`              | `GrayScale`                           | no       | yes      | ColorMode to use, ex: `GrayScale`, or `TrueColor`.                                                                                                                                                   |
+| `IMAGE_FORMAT`            | `png`                                 | no       | no       | Format for the generated images. Acceptable values are `png` or `jpeg`.                                                                                                                              |
+| `DITHER`                  | `false`                               | no       | yes      | Apply a dither to the images.                                                                                                                                                                        |
+| `REMOVE_GAMMA`            | `true`                                | no       | no       | Remove gamma correction from image. Computer images are normally gamma corrected since monitors expect gamma corrected data, however some E-Ink displays expect images not to have gamma correction. |
+| SATURATION              | 2                                   | no       | no       | Saturation level multiplier, e.g. 2 doubles the saturation |
+| CONTRAST                | 2                                   | no       | no       | Contrast level multiplier, e.g. 2 doubles the contrast |
+| BLACK_LEVEL             | 30%                                 | no       | no       | Black point as percentage of MaxRGB, i.e. crushes blacks below specified level |
+| WHITE_LEVEL             | 90%                                 | no       | no       | White point as percentage of MaxRGB, i.e. crushes whites above specified level |
+
+**\* Array** means that you can set `HA_SCREENSHOT_URL_2`, `HA_SCREENSHOT_URL_3`, ... `HA_SCREENSHOT_URL_n` to render multiple pages within the same instance.
+If you use `HA_SCREENSHOT_URL_2`, you can also set `ROTATION_2=180`. If there is no `ROTATION_n` set, then `ROTATION` will be used as a fallback.
+You can access these additional images by making GET Requests `http://localhost:5000/2`, `http://localhost:5000/3` etc.
+
+To make us of the array feature in the Home Assistant Add-On, you may use `ADDITIONAL_ENV_VARS`. It expects a format like this to set any additional environment variable:
+
+```yaml
+- name: "HA_SCREENSHOT_URL_2"
+  value: "/lovelace/second-page"
+- name: "ROTATION_2"
+  value: "180"
+- name: "HA_SCREENSHOT_URL_3"
+  value: "/lovelace/third-page"
+```
+
+To avoid problems, please ensure that the name only contains upper case letters, numbers and underscores. The value field must be a string, so it's better to always put your value (especially numbers) into a `"string"` .
+
+### How to set up the webhook
+
+The webhook setting is to let HA keep track of the battery level of the Kindle, so it can warn you about charging it. You need to do the following:
+
+1. See below for a patch needed to make the Kindle Online Screensaver plugin send the battery level to this application.
+1. Create two new helper entities in Home Assistant:
+   1. a new `input_number` entity, e.g. `input_number.kindle_battery_level`
+   1. a new `input_boolean` entity, e.g. `input_boolean.kindle_battery_charging`
+1. Add an automation to set the values of these entities using a webhook: [![import blueprint](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2Fsibbl%2Fhass-lovelace-kindle-screensaver%2Fblob%2Fmain%2Fbattery_sensor_blueprint.yaml)
+1. Define this application's environment variable `HA_BATTERY_WEBHOOK` to the name of the webhook defined in the previous step. For multiple devices, `HA_BATTERY_WEBHOOK_2`, ... `HA_BATTERY_WEBHOOK_n` is supported as well.
+
+#### Patch for [Kindle Online Screensaver extension](https://www.mobileread.com/forums/showthread.php?t=236104)
+
+Modify the following lines in the Kindle Online Screensaver extension's `bin/update.sh` (absolute path on device should be `/mnt/us/extensions/onlinescreensaver/bin/update.sh`):
+
+```diff
+...
+if [ 1 -eq $CONNECTED ]; then
+-     if wget -q $IMAGE_URI -O $TMPFILE; then
++     batteryLevel=`/usr/bin/powerd_test -s | awk -F: '/Battery Level/ {print substr($2, 0, length($2)-1) - 0}'`
++     isCharging=`/usr/bin/powerd_test -s | awk -F: '/Charging/ {print substr($2,2,length($2))}'`
++     if wget -q "$IMAGE_URI?batteryLevel=$batteryLevel&isCharging=$isCharging" -O $TMPFILE; then
+        mv $TMPFILE $SCREENSAVERFILE
+        logger "Screen saver image updated"
+...
+```
+
+#### Patch for [HASS Lovelace Kindle 4 extension](https://github.com/sibbl/hass-lovelace-kindle-4/)
+
+Modify the following lines in the HASS Lovelace Kindle 4 extension's [`script.sh`](https://github.com/sibbl/hass-lovelace-kindle-4/blob/main/extensions/homeassistant/script.sh#L133) (absolute path on device should be `/mnt/us/extensions/homeassistant/script.sh`):
+
+```diff
+...
+- DOWNLOADRESULT=$(wget -q "$IMAGE_URI" -O $TMPFILE)
++ DOWNLOADRESULT=$(wget -q "$IMAGE_URI?batteryLevel=$CHECKBATTERY&isCharging=$IS_CHARGING" -O $TMPFILE)
+...
+```
+
+### Advanced configuration
+
+Some advanced variables for local usage which shouldn't be necessary when using Docker:
+
+- `OUTPUT_PATH=./output` (destination of rendered image, without extension. `OUTPUT_2`, `OUTPUT_3`, ... is also supported)
 - `PORT=5000` (port of server, which returns the last image)
 - `USE_IMAGE_MAGICK=false` (use ImageMagick instead of GraphicsMagick)
-
-You may also simply use the `docker-compose.yml` file inside this repository, configure everything in there and run `docker-compose up`.
+- `UNSAFE_IGNORE_CERTIFICATE_ERRORS=true` (ignore certificate errors of e.g. self-signed certificates at your own risk)