KFloorP is a floorplan panel dashboard created for Jaiblroken* Kindles and other low specs/older browsers devices, heavily based/inspired on the awesome projects Hatki and Basic-Hass-Dash.

It focus on depending on anything else besides Home Assistant to fetch the data, and to be easy to deploy and maintain.

Features

• It mimics the basic functionalities from the HomeAssistant LoveLace picture-elements card
• Easy to add/change/remove devices
• (Almost) Online Device State Tracking Changes
• No HTML/CSS editing required
• Supports all the following Home Assistant Domains Entities and basic features:
  • SWITCH - with the possibility to customize with the following Icons:
    • washingmachine, microwave, smartplug, dishwasher, heater, fridge, waterfountain, fan
  • BINARY_SENSOR - with the possibility to customize with the following Icons:
    • window, door
  • SENSOR - with the possibility to customize with the following Icons:
    • battery, temperature, humidity, friendly (show attr friendly_name above sensor state), blank (only show the sensor state)
  • MEDIA_PLAYER - with Current Media Display, Play/Pause Control and with the possibility to customize with the following Icons:
    • tv, alexa, googleassistant
  • WEATHER - with Extended forecast function or Today Temperature
• 2nd Floor Support, automatically hidden if no devices informed
• Dedicated Pages with all HA Switches, Lights, Automations or Players, showing up to 50 devices

Requirements

• Your Home Assistant Internal URL with no TLS(SSL) encryption (http not https).
• Your floorplan images for background and your device names from Home Assistant entities.
• A Home Assistant Long Lived Access Token, created from your Account Profile directly on HA.
• Kindle Touch 2nd generation or newer (or any other tablet-like old device).
  • Jailbroken device is preferred but not required, as you need this hack to prevent the native screensaver and to make the device go on full Kiosk Mode.
  • Kindle Jailbreak guides can be found in here
  • You might be able to disable the screensaver without jailbreak. Check it in here
• A WebServer. It runs in almost any basic webserver like httpd/Apache, etc.. Here are some options:
  • If you do not expose your HA to the Internet: you can use HA to host the files, by coping them to your /config/www folder, and them acces it trough your internal HA URL /local path. (e.g http://192.168.182.10:200/local/kafloorp/index.html). Don't do this if your instance is exposed to Internet, as everyone will have access to your dashboard, with no authentication required.
  • If you use Home Assistant OS: Any of the Apache2 Addons from the excelent repository hassio-addons maintained by FaserF.
  • If you use Docker: httpd Official Image

Deployment / Installation

1. After you have your webhost setup, you need to copy all the *.html files, the folders css and js with their contents from this repo to a folder of your preference (or in the root) of your webhost. The structure should be like this:

   ./kfloorp/css/common-style.css
   ./kfloorp/js/main.js
   ./kfloorp/js/setup.js
   ./kfloorp/index.html
   ./kfloorp/2ndfloor.html
   ./kfloorp/switches.html
   ./kfloorp/lights.html
   ./kfloorp/automations.html
   ./kfloorp/players.html

Also add your floorplan images to the same path if you want to host all the files together.

2. Go to your configuration.yaml from your Home Assistant installation add the api module (if not already present) and also add the "cors_allowed_origins" key to the http module with your webserver IP or URL. (The one you will enter on kindle to open KfloorP)

api:

http:
  cors_allowed_origins:
    - 'null'
    - http://YOUR.WEBSERVER.IP.ADDRESS:YOUR_SERVERPORT
    - http://YOUR.WEBSERVER.IP.ADDRESS:YOUR_SERVERPORT/

After adding the lines above to your confituration, remember to restart your Home Assistant Core.

3. Open the setup.js file that is inside the folder js on your webserver using any text editor and follow the instructions inside to add your Home Assistant IP/URL, your LongLived Token, your floorplan images and your devices.

4. Go to the Experimental Web Browser on your Kindle or any PC Browser and open your webserver URL to check it out. E.g.: http://x.x.x.x:8080/kfloorp/index.html

Development

The majority of the development is done using the ancient JavaScript ES3 standard for the sake of older Kindles compatibility, with a few CSS stylization and pure HTML. As Kindle Web Support is not well documented and it does not necessarily behaves like a PC Browser, a lot of hacks were used to make this work. I'm not a real developer and the code is ugly as hell.

Any PR Should be preferably tested on a real Kindle before submitted, but are always welcomed.

Misc

Disable Screensaver without jailbreak

Not Tested: You might be able to disable screensaver on your Kindle without having to Jailbreak it. The instructions below were taken from Basic-Hass-Dash Repository but I have not tested it.

You can disable the screensaver/sleep mode in your Kindle

Newer kindles (2015 Paperwhite & up) type ~ds in the search bar and click search. (Don't worry, After restarting the Kindle the screensaver will return)

Older Kindles: Type ~disableScreensaver in the search box (type del on the home screen) and your Kindle will not go into sleep mode. ~resumeScreensaver will revert the Kindle back to its default (screensaver enabled) state. Note that this does not increase power consumption, as the Kindle consumes no power (with wireless off) when displaying a page

Or < Del > to open the search box on the home screen ;debugOn ~disableScreensaver NOTE: this also stops you from manually using the power switch to enter sleep mode. To re-enable: ~resumeScreensaver and to turn off debug mode: ;debugOff

Contributors

Special thanks to @p1lh4 for many improvements and new features over the first version.