This is a simple yet highly customizable dashboard for Home Assistant. The main goal of this project was to create simple dashboard with an easy way to edit and add functionality with minimum knowledge of javascript and html. Should you have any ideas or questions please post them on home-assistant forum or create an issue on github.
- Pull/download repository
- Copy
config.example.jstoconfig.jsand edit it for your needs - Open index.html directly in a web browser or move all of the files into www directory in HA's config path. Please note that dashboard was designed for local installations and you should never store dashboard files in www directory of HA if you are exposing it to the outside world since this would reveal content of
config.jsalong with the password. As an alternative please consider serving files via Nginx where BasicAuth can be implemented.
config.js will initialize a global CONFIG object with following fields:
var CONFIG = {
/* customTheme: specify a custom theme for your dashboard
* Valid options: null, CUSTOM_THEMES.TRANSPARENT, CUSTOM_THEMES.MOBILE, CUSTOM_THEMES.WINPHONE or a custom theme you have created
* Default: null
*/
customTheme: null,
/* transition: The transition effect used between Pages
* Valid options: TRANSITIONS.ANIMATED, TRANSITIONS.ANIMATED_GPU, TRANSITIONS.SIMPLE
*/
transition: TRANSITIONS.ANIMATED,
/* tileSize: The default size (in pixels) of a tile */
tileSize: Number,
/* tileMargin: The default margin (in pixels) between tiles */
tileMargin: Number,
/* entitySize: Enum size of tile's content (SMALL, NORMAL, BIG)*/
entitySize: ENTITY_SIZES.NORMAL,
/* groupMarginCss: CSS margin statement to override the default margin for groups */
groupMarginCss: '20px 40px',
/* serverUrl: The URL to your HomeAssistant server */
serverUrl: 'http://hassio.local:8123',
/* wsUrl: The URL to your HomeAssistant Websocket connection.
* If HomeAssistant is behind SSL, replace ws:// with wss://
*/
wsUrl: 'ws://hassio.local:8123/api/websocket',
/* passwordType:
* MANUAL - allows you to put the password directly to the config file
* PROMPT - will ask your password every time you open TileBoard in the browser.
* PROMPT_AND_SAVE - same as PROMPT but with saving the password after first connection
* Note: if you used PROMPT_AND_SAVE and changed your password, you will be needed to clear your localStorage
*/
passwordType: PASSWORD_TYPES.PROMPT_AND_SAVE,
/* password: Your HomeAssistant api_password
* NOTE: If TileBoard is accessible to the outside world, people can
* read this file and retrieve your password. TileBoard should be placed behind
* another form of authentication if it is publically accessible.
* Necessary only with MANUAL password type
*/
password: null,
/* timeFormat: 12 for AM/PM marker, 24 for 24 hour time (default) */
timeFormat: Number,
/* menuPosition: LEFT (default) or BOTTOM */
menuPosition: MENU_POSITIONS.LEFT,
/* hideScrollbar: Hiding horizontal scrollbar */
hideScrollbar: false,
/* pages: A list of page objects. See documentation on Pages below */
pages: [],
/* events: A list of events. See documentation on Events below */
events: [],
/* screensaver: A digital picture frame with a clock. Appears when
* the dashboard has been idle
* (optional)
*/
screensaver: {
/* timeout: Idle time (in seconds) before the screensaver will show */
timeout: 300,
/* slidesTimeout: Amount of time (in seconds) to show each slide */
slidesTimeout: 10,
/* slides: Array of paths to pictures. */
slides: [
{bg: 'images/bg1.jpeg'},
{bg: 'images/bg2.png'},
{bg: 'images/bg3.png'}
]
}
}Page object can have following fields:
{
/* title: The page title (not currently used) */
title: 'Page title',
/* bg: Link to the background image */
bg: 'images/bg1.jpg',
/* icon: Page icon for the side menu */
icon: 'mdi-home-outline', // icon of page (for the side menu)
/* head: import a page template as a header
* (used to show the clock in the example configuration)
*/
head: 'head.html',
/* tileSize: Override the global tileSize value for the current page
(optional)
*/
tileSize: Number,
/* groupMarginCss: Override global groupMarginCss for the current page
* (optional)
*/
groupMarginCss: '20px 40px',
/* groups: A list of tile groups. See documentation on Tile Groups below */
groups: [] // list of tile groups
}We divide tiles (cells) into groups on every page. Group object can have following fields:
{
/* title: Title to display above the group */
title: 'Group title',
/* width: Number of tiles horizontally */
width: 3,
/* height: Number of tiles vertically */
height: 4,
/* groupMarginCss: Override default margin of tiles for the current group
* (optional)
*/
groupMarginCss: '20px 40px',
/* items: A list of Tile objects. See documentation on Tiles below */
items: [],
}Tile Object. Click here for some real life examples
{
/* position: The x,y position of the tile inside the group */
position: [1, 0],
/* type: The type of a tile. Valid types are listed below */
type: TYPES.DEVICE_TRACKER,
/* id: The entity_id of the device from HomeAssistant (e.g. switch.xyz or light.family_room) */
id: 'device_tracker.google_maps_228',
// OPTIONAL
/* title: Title for the entity. It will use the friendly_name from HomeAssistant if not specified
* (optional)
*/
title: 'Tile title',
/* subtitle: A subtitle to display on the tile
* (optional)
*/
subtitle: 'Tile subtitle', // subtitle
/* width: How many tiles wide this tile should be
* (optional) (default=1)
*/
width: 2,
/* height: How many tiles tall this tile should be
* (optional) (default=1)
*/
height: 2,
/* states: Map a state from HomeAssistant to a different value for TileBoard to display.
* (optional)
*/
states: {on: 'Enabled', off: 'Disabled'}, // Object example
states: function (item, entity) {return entity.state}, // Function example
/* state: Set a custom state for the tile.
* (optional)
*/
state: 'Working', // String example
state: function (item, entity) {return entity.state}, // Function example
state: false, // Set to false to disable state
/* icons: Set the icon for a tile
* You can use any of the material design icons from https://materialdesignicons.com/
* as long as they have been published in the [latest npm package](https://github.com/templarian/materialdesign-svg).
* Use an object or function to map states to icons
*/
icons: {on: "mdi-volume-high", off: "mdi-volume-off"}, // Object example
icons: function (item, entity) {return entity.attributes.icon}, // Function example
/* icon: Set a static icon for a tile
* You can use any of the material design icons from https://materialdesignicons.com/
* as long as they have been published in the [latest npm package](https://github.com/templarian/materialdesign-svg).
*/
icon: 'mdi-phone'
/* bg: Link to a background image for the tile
* @ and & prefixes are explained below
*/
bg: '@attributes.entity_picture',
/* bgSuffix: Same as bg, but with the serverUrl included */
bgSuffix: '@attributes.entity_picture',
/* bgOpacity: A decimal between 0 and 1 for the background opacity */
bgOpacity: 0.5,
/* theme: Override default theme for the tile */
theme: TYPES.SWITCH,
/* classes: A list of classes to be appended to the tile element
* Useful for custom CSS styles
*/
classes: ["-big-entity"],
/* slides: A list of slide images to use for the background
* Currently a maximum of 3 slides are supported
* (optional)
*/
slides: [{}, {bg: 'images/slide.jpg'}],
/*** TILE SPECIFIC SETTINGS ***/
/** type: SENSOR **/
/* value: Override sensor value */
value: '&sensor.bathroom_temp.state',
/* unit: Override default unit of measurement */
unit: 'kWh',
/* filter: Function for filtering/formatting the entity value */
filter: function (value) {return value},
/** type: DEVICE_TRACKER **/
/* slidesDelay: Delay before slide animation starts */
slidesDelay: 2,
/* map: Map provider for showing position inside tile
* Valid options: 'google', 'yandex'
*/
map: 'google',
/** type: TEXT_LIST **/
/* list: List of objects with a title, icon, and value */
list: [{title: 'Kitchen temp', icon: 'mdi-home', value: '&sensor.kitchen_temp.state'}],
/** type: MEDIA_PLAYER **/
/* hideSource: Whether the source selector should be hidden
* Value options: true, false
*/
hideSource: false,
/** type: SLIDER **/
/* filter: Function for filtering/formatting the value */
filter: function (value) {return value},
/* button: Puts slider at the bottom
* Valid options: true, false
*/
bottom: true,
/* slider: Object with slider config. See slider documentation below */
slider: {}
/** type: CAMERA or CAMERA_THUMBNAIL **/
/* bgSize: CSS background-size property */
bgSize: 'cover',
/* filter: Function for filtering/formatting the camera URL */
filter: function (url) {return url},
/* fullscreen: object of type CAMERA or CAMERA_THUMBNAIL to show it in fullscreen */
fullscreen: {},
/* refresh: Number in milliseconds (or function returning a time) to set the
* interval for refreshing the camera image
*/
refresh: Number || Function,
/** type: LIGHT **/
/* sliders: list of slider object. See slider documentation below */
sliders: [{}],
/** type: WEATHER **/
/* fields: Object mapping available fields and their values.
* Full documentation on fields is below
*/
fields: {},
/* classes: Additional CSS classes. Use 'compact' for a compact (1x1) tile
* (optional)
*/
classes: ['-compact'],
}Every anonymous function will call with context {states: {}, $scope: {}}
At the moment following entity types have been implemented:
var TYPES = {
DEVICE_TRACKER: 'device_tracker',
SCRIPT: 'script',
AUTOMATION: 'automation',
SENSOR: 'sensor',
SENSOR_ICON: 'sensor_icon',
SWITCH: 'switch',
LOCK: 'lock',
COVER: 'cover',
FAN: 'fan',
GENERIC_ICON: 'generic_icon',
INPUT_BOOLEAN: 'input_boolean',
LIGHT: 'light',
TEXT_LIST: 'text_list',
INPUT_NUMBER: 'input_number',
INPUT_SELECT: 'input_select',
CAMERA: 'camera',
CAMERA_THUMBNAIL: 'camera_thumbnail',
SCENE: 'scene',
SLIDER: 'slider',
IFRAME: 'iframe',
DOOR_ENTRY: 'door_entry',
WEATHER: 'weather',
CLIMATE: 'climate',
MEDIA_PLAYER: 'media_player',
CUSTOM: 'custom',
ALARM: 'alarm',
WEATHER_LIST: 'weather_list',
};Example of slider config used for LIGHT:
{
title: "Color temp",
field: "color_temp",
max: 588,
min: 153,
step: 15,
request: {
type: "call_service",
domain: "light",
service: "turn_on",
field: "color_temp"
}
}Supported weather fields
{
icon: '&sensor.dark_sky_icon.state',
iconMap: {'clear-day': 'clear', ...}, // statusKey: iconName (from images/weather-icons)
//iconMap: function (icon, item, entity) {return icon}, // or use function
summary: '&sensor.dark_sky_summary.state',
apparentTemperature: '&sensor.dark_sky_apparent_temperature.state',
apparentTemperatureUnit: '&sensor.dark_sky_apparent_temperature.attributes.unit_of_measurement',
temperature: '&sensor.dark_sky_temperature.state',
temperatureUnit: '&sensor.dark_sky_temperature.attributes.unit_of_measurement',
highTemperature: '&sensor.dark_sky_daytime_high_temperature.state',
highTemperatureUnit: '&sensor.dark_sky_daytime_high_temperature.attributes.unit_of_measurement',
lowTemperature: '&sensor.dark_sky_overnight_low_temperature.state',
lowTemperatureUnit: '&sensor.dark_sky_overnight_low_temperature.attributes.unit_of_measurement',
precip: '&sensor.dark_sky_precip.state',
precipIntensity: '&sensor.dark_sky_precip_intensity.state',
precipIntensityUnit: '&sensor.dark_sky_precip_intensity.attributes.unit_of_measurement',
precipProbability: '&sensor.dark_sky_precip_probability.state',
precipProbabilityUnit: '&sensor.dark_sky_precip_probability.attributes.unit_of_measurement',
windSpeed: '&sensor.dark_sky_wind_speed.state',
windSpeedUnit: '&sensor.dark_sky_wind_speed.attributes.unit_of_measurement',
humidity: '&sensor.dark_sky_humidity.state',
humidityUnit: '&sensor.dark_sky_humidity.attributes.unit_of_measurement',
pollen: '&sensor.pollen_count.state',
pressure: '&sensor.dark_sky_pressure.state',
pressureUnit: '&sensor.dark_sky_pressure.attributes.unit_of_measurement',
}As you may notice that we use @/& prefixes to get a value inside objects (entities). @ is relative to the current entity (@attributes.friendly_name) and & is for global (&sensor.kitchen_temp.state). This may not work everywhere, but you may give it a go.
Events can be fired from Home Assistant to control TileBoard. Useful for automations to do things like opening a camera view if it detects motion, or turning the screen off on a tablet at night or when everyone leaves.
Events in HomeAssistant must be fired with tileboard as the event type, and a command included in the event data.
events: [
/* Example: Start the screensaver on a tablet with Fully Kiosk Browser */
{
/* command: The command sent from Home Assistant */
command: 'screen_off',
/* action: Function to execute when the command is received
* The variable e contains the full event_data from HomeAssistant
*/
action: function(e) {
if (typeof fully !== undefined) {
fully.startScreensaver();
}
},
},
/* Example: End the screensaver and make sure Fully Kiosk Browser is in
* the foreground.
*/
{
command: 'screen_on',
action: function(e) {
if (typeof fully !== undefined) {
fully.stopScreensaver();
fully.bringToForeground();
}
},
},
/* Example: Play a sound file
* Include sound_url in the event_data from Home Assistant
*/
{
command: 'play_sound',
action: function(e) {
playSound(e.sound_url);
}
},
/* Example: Open a specific TileBoard page
* Include a page field in the event_data from Home Assistant
* that matches the id: of a page in the TileBoard CONFIG
*/
{
command: 'open_page',
action: function(e) {
var page = CONFIG.pages.filter(function(obj) {
return obj.id == e.page;
});
this.$scope.openPage(page[0]);
}
}
],TileBoard has built-in support for toast notification popups in the
lower right corner. To set them up, add the following to events in CONFIG:
{
command: 'notify',
action: function(e) {
Noty.addObject(e);
}
}You can then fire a tileboard event in HomeAssistant with the following data:
{
"command": "notify",
"id": "hello",
"icon": "mdi-car",
"type": "info",
"title": "Information",
"message": "Hello world",
"lifetime": 5,
}id: Notification ID. Sending multiple notifications with the same id will overwrite each other.
type: Type of notification (for style purposes). Valid types are error, info, success, warning
lifetime: Length of time (in seconds) for the notification to persist before automatically dismissing. Leave lifetime out of the event_data for persistent messages.
A number of classes are added to each tile depending on the type of tile and state. Custom CSS styles can be applied by creating a custom.css file in the styles directory.
Please feel free to post an issue or pull request and we will sort it out
MIT License