All Configuration Fields

Advanced config

Note: This documentation is incomplete and still a work in progress

Here's a list of all available configuration fields for TileBoard:

Main TileBoard Configuration

Home Assistant Settings

• serverUrl The URL to your HomeAssistant server.
  Required
  Example: serverUrl: 'http://192.168.12.34:8123'

• wsUrl The URL to your HomeAssistant Websocket connection.
  Required
  Example: wsUrl: 'ws://192.168.12.34:8123/api/websocket'
  If HomeAssistant or TileBoard are set up to utilize SSL, you will need to use wss:// in the wsURL.

• passwordType The method used for TileBoard to authenticate with your HomeAssistant server.
  Example: passwordType: PASSWORD_TYPES.PROMPT_AND_SAVE
  Valid password types are:

  • MANUAL Use password specified in config.js NOTE: do NOT use this method if TileBoard is on a publically accessible page as it will expose your HomeAssistant password.
  • PROMPT_AND_SAVE Prompts you for a password and saves it in your browser's localStorage.
  • PROMPT Prompts for a password every time you load TileBoard.

• password HomeAssistant api_password - Use only with MANUAL passwordType, do NOT use if TileBoard is publically accessible.

TileBoard Theme/Layout Settings

• transition The transition effect used between Pages.
  Valid options are ANIMATED_GPU, ANIMATED or BASIC.
  Example: transition: ANIMATED_GPU

• tileSize The default size (in pixels) of a tile. Required
  Example: tileSize: 150

• tileMargin The default margin (in pixels) between tiles. Example: tileMargin: 6

• customTheme A custom theme to use
  Optional - Default: null
  Valid options are CUSTOM_THEMES.TRANSPARENT, CUSTOM_THEMES.WIN95, CUSTOM_THEMES.MOBILE, CUSTOM_THEMES.WINPHONE
  Example: customTheme: CUSTOM_THEMES.TRANSPARENT

• groupMarginCss CSS string for group margins
  Example: groupMarginCss: '20px 40px'

• timeFormat 12 or 24 hour clock.
  Optional - Default: 24
  Example: timeFormat: 12
  

• menuPosition Position of the page menu
  Optional - Default: MENU_POSITIONS.LEFT
  Valid options are MENU_POSITIONS.LEFT, MENU_POSITIONS.BOTTOM
  Example: menuPosition: MENU_POSITIONS.BOTTOM
  

• hideScrollbar Whether or not to hide the browser scrollbars
  Optional - Default: false
  Example: hideScrollbar: true

• entitySize Default entity sizes
  Optional - Default: ENTITY_SIZES.NORMAL
  Valid options are ENTITY_SIZES.SMALL, ENTITY_SIZES.NORMAL, ENTITY_SIZES.BIG
  Example: entitySize: ENTITY_SIZES.SMALL

Pages

• title of page (not currently used)
• bg link to bg image
• icon icon class for sidebar
• head import a page template as a header
• tileSize override the global tileSize value for the current page
• groupMarginCss override global groupMarginCss for the current page
• groups list of groups

Here is a detailed guide on Pages

Groups

• title Title to display above the group
• width count of tiles horizontally
• height count of tiles vertically
• groupMarginCss override default margin of tiles for the current group
• items list of tiles

Tiles