Difference between revisions of "Hubitat™ Dashboard v1"

From Hubitat Documentation
Jump to: navigation, search
(Moved content)
 
(Temp update)
Line 1: Line 1:
−
Hubitat™ Dashboard gives you remote access to monitor and control your devices from your phone, tablet or desktop. This is a highly customizable dashboard that lets your choose the devices and layout you want to see. You can even set up multiple dashboards if you want to provide custom dashboards for each member of your house. Here's how to set it up.
 
  
−
==Creating Your Dashboard==
+
Hubitat<sup>®</sup> Dashboard app is a powerful and fast, grid-based tile solution for local and remote access. You can quickly create highly customizable Dashboards to monitor and control your devices from a phone, tablet or desktop. Multiple Dashboards can be assigned to specific users, allowing a custom layout for individual or multiple users. A convenient QR code capture grants access for the assigned Dashboards on a per user basis.
  
−
#Load the Hubitat™ Dashboard App in the Hubitat Web Interface.
+
===Installing Hubitat<sup>®</sup> Dashboard===
−
#Click on ''Create a New Dashboard''
 
−
#:[[File:DB1.png|link=https://docs.hubitat.com/File:DB1.png]]
 
−
#Give your dashboard a name. This name will appear at the top of the HTML dashboard. Pick something descriptive such as the room this dashboard is controlling or its main purpose.
 
−
#:[[File:DB2.png|link=https://docs.hubitat.com/File:DB2.png]]
 
−
#Next, decide if you want to authorize all devices to the dashboard or just a select few devices. You can choose to use all devices by toggling the ''Use all your devices'' switch to ''On''. If you want to pick only a few devices, select ''Choose Devices'' and check the devices you want to see on your dashboard.
 
−
#:[[File:DB3.png|link=https://docs.hubitat.com/File:DB3.png]]
 
−
#Now pick your layout. If you want to use the default layout, just click ''Next''.  Click the ''Layout Options'' button to configure grid to customize your dashboard layout.
 
  
−
::ADD SCREENSHOT
+
#From the Hubitat Web Interface select '''Apps'''[[File:Install Built-In App 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Install_Built-In_App_2.0.png]]
 +
#Choose the Hubitat<sup>®</sup> Dashboard from the list of Hubitat Elevation<sup>®</sup> Built-In Apps[[File:Install Hubitat Dashboard.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Install_Hubitat_Dashboard.png]]
  
−
#Hubitat™ Dashboard uses a grid system for populating your devices in the dashboard. In the ''Layout Options'' section you can select one of the default grids or specify the exact number of Rows and Columns you want. Don’t worry; you can change all of this later, even in the actual dashboard interface.
+
===Configure Dashboard App Menu===
−
#:[[File:DB4.png|link=https://docs.hubitat.com/File:DB4.png]]
 
−
#If you want all the devices you selected to be displayed on your dashboard, toggle on ''Auto Populate Dashboard.'' The dashboard automatically assign a tile for each device and place it on the dashboard. If you have more devices than grid spots, it will fill all the open spots and you can change them in the dashboard. Once your dashboard is created (or if you leave this toggle off), devices can be added/removed devices in the dashboard itself.
 
−
#:[[File:DB5.png|link=https://docs.hubitat.com/File:DB5.png]]
 
−
#Toggle the ''Read-Only Dashboard'' on if you do not want to allow the user to change the dashboard in the Dashboard interface. You will want to leave this ''off'' until you have set up the dashboard to your liking, then come back in here and toggle it off.
 
−
#:[[File:DB6.png|link=https://docs.hubitat.com/File:DB6.png]]
 
−
#Finally you need to select your ''Background Options.'' Use the dropdown menu to select one of the background colors. You can also select a background image by directing the dashboard to its web address. A default “Hubitat” logo is included, but you can change or remove this to your liking. These two options are also configurable in the Dashboard Interface, once the dashboard is set up.
 
−
#:[[File:DB7.png|link=https://docs.hubitat.com/File:DB7.png]]
 
−
#Click “Done” and your first dashboard is installed.
 
  
−
'''Import/Export Dashboard Layout'''
+
*'''Dashboard Menu''' - Once you have your first Dashboard created, you will have a list of Dashboards for quick access here. You can switch between Local and Cloud links using the two tab buttons.
 +
*'''Send Mobile App Link to Phone''' -  This option allows you to text a link to someone to access the Hubitat<sup>®</sup> Dashboard Menu remotely.[[File:Create new dashboard.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Create_new_dashboard.png]]
  
−
At the bottom of the layout options page you will see the option to ''Import/Export Layout''. Click on this tab and you will see the current layout “json” code and a box to paste in new “json” layout code and override your existing layout. Copying the current code, then creating a new dashboard and pasting the code in this box is a fast way to duplicate any dashboard.
+
===Advanced Options===
  
−
'''WARNING:''' pasting code into the Import text box could break your dashboard. Make sure you have a copy of your current layout (above) before pasting in a new layout.
+
*'''Remove Hubitat Dashboard''' - Selecting this button will remove the Hubitat<sup>®</sup> Dashboard app app.
 +
*'''Allow new Dashboards to be created from Dashboard Menu -''' This option enables you to control if new Dashboards allowed to be created from the Dashboard menu.
 +
*'''Use Legacy Dashboards?''' - Allows you to go back to Dashboard 1.0 rendering. '''NOTE:''' ''If you add any new template tiles, this could cause legacy Dashboards to not render.''
  
−
:[[File:DB68.png|link=https://docs.hubitat.com/File:DB68.png]]
+
===Creating a Dashboard===
  
−
Once you have pasted in a different layout, tab out of the box and you will see this:
+
#Select ''Create a New Dashboard''
 +
#Give your Dashboard a name. This name will appear at the top of the Dashboard. Pick something descriptive such as the room your Dashboard is controlling, or its main purpose.
 +
#Under the '''Links''' section, you will find '''Local''' and '''Cloud''' links to your new Dashboard. These are standard Web URLs that you can bookmark to allow direct and easy access to your Dashboards.  '''Local LAN Link''' is accessible inside your home, while on the ''same network'' and it features instant updates. '''Cloud Links''' are remotely accessible URLs that you can use to access your Dashboard from the internet, when you are outside your local network.[[File:New Dashboard.png|600x600px|link=https://docs.hubitat.com/File:New_Dashboard.png]]
 +
#Under '''Advanced,''' you can set some options that affect the access to your Dashboards.
 +
#*You can change how fast the Dashboard should refresh via cloud and local links.  
 +
#*You may set a Pin / Password to protect this Dashboard from loading.
 +
#*You can set a numerical (numbers only ) PIN for Hubitat<sup>®</sup> Safety Monitor and for Modes.
 +
#*It is also possible to disable access for this Dashboard from '''Cloud Links''' and/or from '''Local Links'''.
 +
#*Lastly, you can set this Dashboard to “'''Read Only'''”, which will not allow any changes from inside the Dashboard app itself.[[File:Dashboard Advanced.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Dashboard_Advanced.png]]
 +
#Next, decide if you want to authorize all devices to the Dashboard or just a select few devices. You can choose specific devices by disabling the '''''Use all your devices''''' switch. If you want to pick only a few devices, select '''''Choose Devices''''' and check the devices you want to see on your Dashboard. Limiting the devices in larger installs will speed up the loading of Dashboards.
 +
#Choose “Done” and your first Dashboard is now installed.
  
−
:[[File:DB69.png|link=https://docs.hubitat.com/File:DB69.png]]
+
===Accessing Dashboards===
  
−
This means your new layout is now imported. If not, restore your old layout or you might have to start a new dashboard and paste your backup into this.
+
#Now that we have your first Dashboard set up, let’s head over to it. Choose the local link and open your new Dashboard in a new window.
 +
#You will now see the Getting Started dialog box, briefly explaining how Dashboard 2.0 functions.[[File:Getting Started Dashboard.png|none|thumb|678x678px|link=https://docs.hubitat.com/File:Getting_Started_Dashboard.png]]
 +
#You have a couple options to get started. You can '''Manually Add Tiles''' (or just close this dialog) and get started, or you can select '''Auto Fill Grid''' and all your devices will be automatically added to the Dashboard with a default tile template.
  
−
You can share this layout “json” in the community or with others if you have designed a cool layout. Only your device IDs are stored in the layout, along with any images, links or dashboard IDs. It is pretty safe to share this, but if you want to edit the text, change each device Id to 1.
+
===Dashboard Builder===
  
−
When importing someone else’s layout, exercise caution and realize you will need to update each tile with your own devices.
+
#You can also use the new Dashboard Builder by selecting the link '''Dashboard Builder''' in the menu bar as shown below. Dashboard Builder allows you to create a Dashboard based on the devices you have authorized and their specific “attributes”.  Select which ones you want to create, and you can then choose '''Build My Dashboard''' to create a quick and easy Dashboard that contains groups of each of these types of devices.
 +
#Both '''Auto Fill Grid''' described in the previous section, and '''Dashboard Builder''' will automatically optimize their default Grid Size for the browser you are currently using. It is best to use the browser and device you intend to normally use with Hubitat<sup>®</sup> Dashboards, so this automated process can build a Dashboard specifically for your device and choice of web browser.[[File:Dashboard Builder.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Dashboard_Builder.png]]
  
−
Overall, Hubitat™ Dashboard is a very powerful, fast grid-based tile solution. We hope you enjoy using your dashboards. More tile templates are in the works and please provide your feedback in the community thread for dashboard tiles and we can see what we can do to accommodate your needs.
+
===Add A Tile===
  
−
==Loading and Editing Your Dashboard==
+
#Select the '''+''' icon in the top right to open the '''Add A Tile''' dialog. Here  you can set the number of '''Columns''' and '''Rows''' by either using the '''-/+''' buttons, or clicking anywhere on the grid.
 +
#You can also change the tile '''Width''' and '''Height''' to set how big the tile will be.
 +
#Next, '''Pick a Device''', then '''Pick a Template''', and finally set the '''Options''' for that template.
 +
#Select '''Add Tile''' and you will see the tile added to your Dashboard in the spot you selected. The Grid will change to gray in that spot where your Dashboard now has a tile.[[File:Add a Tile.png|none|thumb|676x676px|link=https://docs.hubitat.com/File:Add_a_Tile.png]]
  
−
'''Loading Your Dashboard(s)'''
+
===Edit Tile===
  
−
#In your Dashboard App, you will now see a link to the “Dashboards Menu”. Click on this and a new window/tab will open in your browser. Bookmark this URL / Link for quick access all your dashboards. Each dashboard has a Cloud and Local LAN Link. The Cloud Link allows your dashboard to be viewed from anywhere with internet access. The Local LAN link allows your dashboard to only be accessed on your home network. The Local LAN Dashboard will be faster to load and update. When you are on your local / home network, use this link.
+
#You can edit any tile by clicking the 3 dot menu in the top right of any tile. This will open an editing window and allow you to move the tile around on the grid by selecting the '''-/+''' or by clicking the grid layout to move your tile to that position on the Dashboard.
−
#:[[File:DB8.png|link=https://docs.hubitat.com/File:DB8.png]]
+
#You can quickly jump between editing of tiles by using the back and forward buttons in the menu bar to either side of '''Edit Tile ID:'''
 +
#You can change the '''Device''', the '''Template''' or any '''Options''' for the tile.[[File:Edit Tile.png|none|thumb|676x676px|link=https://docs.hubitat.com/File:Edit_Tile.png]]
 +
#Selecting '''History''' in the menu bar will open up a window with a list of activities for that device from the event table.[[File:Device History.png|none|thumb|679x679px|link=https://docs.hubitat.com/File:Device_History.png]]
 +
#If you want to remove the tile, press the '''Delete Tile''' button.
  
−
'''Customizing Your dashboard'''
+
===Settings===
  
−
#Click on the Local LAN Dashboard link for the dashboard your created. If you had chosen the ''populate dashboard'' option at setup the grid would be full of devices you authorized. Otherwise you will see the default empty dashboard.
+
#Selecting the gear icon in the top right opens up the '''Settings''' page for this Dashboard.
−
#Tap the three dots in the upper right hand corner to open the dynamic “Side Menu”. Here you can change the Grid Layout Settings, Add, Edit or Remove Tiles.
+
#There are 4 distinct options: Grid, Options, Templates and Advanced
−
#:[[File:DB10.png|link=https://docs.hubitat.com/File:DB10.png]]
+
#*'''Grid''' - You can change the grid size (columns and rows), font size, icon size, grid gap, as well as how rounded the corners are for all tiles. You may also paste in a URL for a background image, or set a color including a custom HTML value for the background of the grid.[[File:Options Grid.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Options_Grid.png]]
 +
#*'''Options -''' Here you can change a variety of options for how your Dashboard will display (or will not display) information
 +
#**'''Clock 12 Hour Mode (Turn off for 24 hour time)''' - Choose between 12 hour or 24 time display for any clock template or history
 +
#**'''Date Format - S'''witch between '''MM/DD/YYYY''' and '''DD/MM/YYYY''' formats
 +
#**'''Cloud and LAN''' '''Refresh Intervals - S'''et these to determine how fast the Dashboard will poll to show updates on screen.  '''''NOTE:''' LAN refresh is only if a Dashboard can’t connect via websocket.  When connected via websockets, updates should be immediate.''
 +
#**'''Column Width and Row Height -''' Remove these to auto fit tiles to the grid, or change these to specific values to force the Dashboard to render these tiles as fixed sizes, forcing the Dashboard to scroll if it overflows the browser window.
 +
#**'''Allow Logo Click -''' Disable this if you don’t want to use this option as a means to return to the Dashboard menu.
 +
#**'''Hide 3 dots -''' This will hide all the 3 dot menu at the top-right of each tile. You will need to re-enable the 3 dot menu if you want to edit tiles. '''''NOTE:''' This does not make the tiles read only, and the option can be still be set from inside the Dashboard App settings in the Hubitat Web Interface.''
 +
#**'''Hide Tile Template Names -''' This allows you to remove the names that are at the top of most templates.
 +
#**'''Hide Icon Helper Text -''' Hides the text under each icon that indicates the attribute value.
 +
#**'''Hide Device History -''' Used to remove the option to view device history in the tile details area.
 +
#**'''Do Not Use Default Tile Colors -''' Turning this on will disable the default colors for templates.[[File:Options.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Options.png]]
 +
#****
  
−
'''Change the Grid Size'''
+
===Templates===
  
−
#Your dashboard is broken up into a Grid. This grid is defined by Rows and Columns. This was set when you created your dashboard but can be changed here in the dashboard. Tap the arrows next to each number to adjust the number of rows/columns. You will notice a real-time preview of expanding or shrinking grid.
+
*In this section you can change the Color, Background Color and Custom Icons for each state available for a template.[[File:Templates.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Templates.png]]
−
#:[[File:DB12.png|link=https://docs.hubitat.com/File:DB12.png]]
 
−
#You can change the Background Color, Background Image and change the font size as well. The little “I” icon in the bottom right corner of the side menu has a popup with the code for your layout and devices.
 
−
#:[[File:DB13.png|link=https://docs.hubitat.com/File:DB13.png]]
 
−
#:[[File:DB14.png|link=https://docs.hubitat.com/File:DB14.png]]
 
−
#Tap ''Update Grid'' to save your changes and see them on the dashboard.
 
  
−
'''Add A Tile'''
+
===Advanced===
  
−
#Below the Grid Size Section is the Add Tile section. This will not appear if the grid is already full. You may need to add a row/column or delete a tile to make space.
+
*'''Layout -''' This area allows you to copy and paste in layouts or make direct edits to your options, layout and custom colors.  Quickly share custom colors or layouts using the code from this window.[[File:Advanced Layout.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Advanced_Layout.png]]
−
#You can add a tile anywhere in the grid. Use the arrow keys to adjust the row/column you want the tile place. It will default to the first available space from Left to Right, Top to Bottom.
+
*'''Devices -''' This area allows you to see a list of authorized devices, the current states and history (if enabled) for each device.  This is helpful to troubleshoot if a device is reporting proper states.
−
#Each tile can also “Span” Rows and Columns, allowing you to create larger tiles then the default 1x1 size. Set this using the arrows.
 
−
#:[[File:DB15.png|link=https://docs.hubitat.com/File:DB15.png]]
 
−
#Next you will select the Tile Options for this new tile. Use the dropdown to select the device you want repressed. This dropdown list contains all of your authorized devices with initialized attributes. If a new device doesn’t show up here,
 
  
−
remember to update the device in the device view so that a state/attribute is set.
+
:
−
 
 
−
#:[[File:DB16.png|link=https://docs.hubitat.com/File:DB16.png]]
 
−
#Next you select the template for the device most template match up with a specific device. However, some templates are single attribute focused. Like “battery” or “temperature”. These single attribute templates will just show that attribute of a device (if for example you just want to see the temperature reading of your motion sensor). Other templates are multi attribute capable and can show you more information or give you multiple options for control. For example, the “dimmer” template will give you the option to turn on/off the dimmer but also includes a slider to adjust the dim level.
 
−
#:*'''NOTE 1:'''There are two special “devices” called “Dashboards” and “Modes”. The “Dashboard” device allows you to pick any other dashboard you have configured and it will create a “dashboard” tile that when clicked, will take you to that dashboard. The “Modes” device allows you to create a tile that has the ability to display and select any mode for your location / hub. Both these special “devices” must also be used in conjunction with their corresponding “template” called “dashboard” and “mode”.
 
−
#:*'''NOTE 2''' The “image” and “link” templates do not require a device. Both of these will ignore the device selection, instead will show another input box that will allow you to paste in a link or a link to any image and that will be displayed in the tile.
 
−
#:[[File:DB17.png|link=https://docs.hubitat.com/File:DB17.png]]
 
−
 
 
−
'''Edit a Tile'''
 
−
 
 
−
Once your tile is added you can edit the location, device type, template and colors.
 
−
 
 
−
#Open the tile editor by tapping the three dots in the upper righthand corner of the tile.
 
−
#You can edit the position, size and type just as your did when you added the tile.
 
−
 
 
−
'''Adjust the Template Colors'''
 
−
 
 
−
#Tap ''template colors'' button near the top of the side menu.
 
−
#:[[File:DB18.png|link=https://docs.hubitat.com/File:DB18.png]]
 
−
#In the pop-up window, select the template you would like to edit.
 
−
#:[[File:DB20.png|link=https://docs.hubitat.com/File:DB20.png]]
 
−
#Select the state of the device you would like to edit. Each device state can have a different color palette for quick visual reference.
 
−
#:[[File:DB21.png|link=https://docs.hubitat.com/File:DB21.png]]
 
−
#The icon color and background color of each template can be edited. Tap on the color you want to change, then use the color wheel and slider to select the color. When you have select the icon and background colors, tap ''Save Custom Color''
 
−
#:[[File:DB22.png|link=https://docs.hubitat.com/File:DB22.png]]
 
−
#Repeat for any other templates and states you want to change. These settings are saved in your layout.
 
−
#:*'''NOTE:''' If you use the populate all devices in the Layout Section of the Child Dashboard App, you will remove your custom colors. This option can be used to reset your custom colors.
 
−
 
 
−
As you can see, this grid layout is very flexible and allows precise placement of your tiles without the need to add spacers, and will not change regardless of the resolution of your device. This is a departure from other dashboard solutions out there, as they flow the tiles based on landscape or portrait modes.
 
−
 
 
−
You can create specific layouts for specific screens, devices, etc. In fact. You can even share your layouts with others or use that layout to create other dashboards based on that layout. Even restore your dashboards if something were to go wrong.
 
−
 
 
−
==Advanced Options==
 
−
In the Dashboard app there are a handful of options for advanced users to fine-tune their dashboards.
 
−
 
 
−
'''Refresh Rate''' Here you can specify the refresh rate (in seconds) for your LAN and cloud-connected dashboards. LAN connections are faster so it recommend you set that faster than your cloud-based dashboard links.
 
−
 
 
−
'''Clock AM/FM''' Toggle this ''on'' for your dashboard to display time in AM/FM format (default). Toggle this ''off'' to display in 24-hour format.
 
−
 
 
−
'''Security''' This allows you to create a PIN that will be required for anyone attempting to load the dashboard. Simply enter the PIN of your choice in the blank field. Next, toggle whether you want this PIN to be required for the LAN dashboard and/or the cloud dashboard. When you are finished, click ''done''.
 
−
 
 
−
'''Helpful Hints:'''
 
−
 
 
−
*Hubitat™ Dashboard has a built in refresh rate of 2 seconds for local lan dashboards and 5 seconds for cloud based links. You can adjust this in the Advanced Section of the Dashboard Child App.
 
−
 
 
−
*The tile sends the command, but doesn’t assume it is changed until after we get a message back that the device state has changed. This can cause a small delay and a loading icon for your cursor and a slight fade out and back in of the tile when command is confirmed.
 
−
 
 
−
=='''Device Templates:'''==
 
−
 
 
−
'''Acceleration'''
 
−
 
 
−
This is a single use tile that displays acceleration status of any device with the acceleration attribute.
 
−
 
 
−
:[[File:DB24.png|link=https://docs.hubitat.com/File:DB24.png]]
 
−
 
 
−
'''Attribute'''
 
−
 
 
−
This is a custom tile that will display the text value of any attribute name. Just enter the name below the drop down.
 
−
 
 
−
:[[File:DB25.png|link=https://docs.hubitat.com/File:DB25.png]]
 
−
:[[File:DB26.png|link=https://docs.hubitat.com/File:DB26.png]]
 
−
 
 
−
'''Battery'''
 
−
 
 
−
This is a single use tile that displays the battery status of any device with the battery attribute.
 
−
 
 
−
:[[File:DB27.png|link=https://docs.hubitat.com/File:DB27.png]]
 
−
 
 
−
'''Bulb'''
 
−
 
 
−
This is a multi use tile that displays the current state of the switch and level of a bulb. You can move the slider to change the level.
 
−
 
 
−
:[[File:DB28.png|link=https://docs.hubitat.com/File:DB28.png]]
 
−
 
 
−
'''Button'''
 
−
 
 
−
This is a single use tile that uses a device that has one or more pushable Buttons. Once you choose the button template, you will then be able to enter the number of the button to send the pushed command.
 
−
 
 
−
:[[File:DB29.png|link=https://docs.hubitat.com/File:DB29.png]]
 
−
 
 
−
'''Carbon-dioxide'''
 
−
 
 
−
This is a single use tile that displays the reported carbon dioxide (CO2) levels in parts per million (ppm)
 
−
 
 
−
:[[File:DB30.png|link=https://docs.hubitat.com/File:DB30.png]]
 
−
 
 
−
'''Carbon-monoxide'''
 
−
 
 
−
This is a single use tile that displays if Carbon Monoxide is detected or not. The green cloudy icon indicates the presence of Carbon monoxide as reported by the device.
 
−
 
 
−
:[[File:DB31.png|link=https://docs.hubitat.com/File:DB31.png]]
 
−
 
 
−
'''Clock-date'''
 
−
 
 
−
This is a special tile that displays your local browser time with seconds along with the current date.
 
−
 
 
−
:[[File:DB32.png|link=https://docs.hubitat.com/File:DB32.png]]
 
−
 
 
−
'''Clock'''
 
−
 
 
−
This is a special tile that displays your local browser time with seconds.
 
−
 
 
−
:[[File:DB33.png|link=https://docs.hubitat.com/File:DB33.png]]
 
−
 
 
−
'''Contact'''
 
−
 
 
−
This is a single use tile that displays the contact attribute of a device. Green means open, gray means closed.
 
−
 
 
−
:[[File:DB34.png|link=https://docs.hubitat.com/File:DB34.png]]
 
−
 
 
−
'''Dashboard'''
 
−
 
 
−
This is a special tile that allows you to create a “link” to another dashboard on your current dashboard. This tile is smart enough to know if it is cloud or local based link based on what dashboard link is currently in use.
 
−
 
 
−
:[[File:DB35.png|link=https://docs.hubitat.com/File:DB35.png]]
 
−
 
 
−
'''Dimmer'''
 
−
 
 
−
This is similar to the Bulb tile. Click to turn on/off the Dimmer and the arrow icons to change the level.
 
−
 
 
−
:[[File:DB36.png|link=https://docs.hubitat.com/File:DB36.png]]
 
−
 
 
−
'''Door'''
 
−
 
 
−
This is similar to the Contact tile and indicates if a door is open (green) or closed (gray) to be used with the contact attribute of a device.
 
−
 
 
−
:[[File:DB37.png|link=https://docs.hubitat.com/File:DB37.png]]
 
−
 
 
−
'''Door-control'''
 
−
 
 
−
This is similar to the Contact tile and indicates if a door is open (green) or closed (gray) to be used with the contact attribute of a device. Taping the tile will send the open or closed command after a confirmation dialog box.
 
−
 
 
−
:[[File:DB37.png|link=https://docs.hubitat.com/File:DB37.png]]
 
−
 
 
−
'''Energy'''
 
−
 
 
−
This is a single use tile that displays the energy attribute reported from the device.
 
−
 
 
−
:[[File:DB38.png|link=https://docs.hubitat.com/File:DB38.png]]
 
−
 
 
−
'''Garage'''
 
−
 
 
−
This is a single use tile that displays the contact attribute closed is gray and pointing down, and open is green and pointing up.
 
−
 
 
−
:[[File:DB39.png|link=https://docs.hubitat.com/File:DB39.png]]
 
−
 
 
−
'''Garage-control'''
 
−
 
 
−
This is a single use tile that displays the contact attribute closed is gray and pointing down, and open is green and pointing up.Taping the tile will send the open or closed command after a confirmation dialog box.
 
−
 
 
−
:[[File:DB39.png|link=https://docs.hubitat.com/File:DB39.png]]
 
−
 
 
−
'''Humidity'''
 
−
 
 
−
This is a single use tile that displays the humidity attribute as a percentage.
 
−
 
 
−
:[[File:DB40.png|link=https://docs.hubitat.com/File:DB40.png]]
 
−
 
 
−
'''Illuminance'''
 
−
 
 
−
This is a single use tile that displays the light level in lux from the device.
 
−
 
 
−
:[[File:DB41.png|link=https://docs.hubitat.com/File:DB41.png]]
 
−
 
 
−
'''Image'''
 
−
 
 
−
This is a special tile that allows you to insert a link to any image. This will be refreshed every 5 minutes. Once you choose the image template, a box will display allowing you to add the link.
 
−
 
 
−
:[[File:DB42.jpg|link=https://docs.hubitat.com/File:DB42.jpg]]
 
−
 
 
−
'''Link'''
 
−
 
 
−
This is a special tile that allows you to create a clickable link to any website that will open up in a new tab. Currently, you can not rename the link. This will be added in a later version.
 
−
 
 
−
:[[File:DB43.png|link=https://docs.hubitat.com/File:DB43.png]]
 
−
 
 
−
'''Lock'''
 
−
 
 
−
This is a multipurpose tile that shows the lock state and battery. Clicking on the lock will lock (green) or unlock (gray) the lock.
 
−
 
 
−
:[[File:DB44.png|link=https://docs.hubitat.com/File:DB44.png]]
 
−
 
 
−
'''Mode'''
 
−
 
 
−
This is a special tile that will allow you to view the current mode and select a new mode for your hub / location.
 
−
 
 
−
:[[File:DB45.png|link=https://docs.hubitat.com/File:DB45.png]]
 
−
 
 
−
'''Momentary'''
 
−
 
 
−
This is a single purpose tile that takes a device with the push attribute but will only send “on” (green) and it will return back to gray after the push command has been sent.
 
−
 
 
−
:[[File:DB46.jpg|link=https://docs.hubitat.com/File:DB46.jpg]]
 
−
 
 
−
'''Motion'''
 
−
 
 
−
This is a multipurpose tile showing motion detected (green eye) or not (gray) and the values of the temperature sensor and battery level.
 
−
 
 
−
:[[File:DB47.png|link=https://docs.hubitat.com/File:DB47.png]]
 
−
 
 
−
'''Multi'''
 
−
 
 
−
This is a multipurpose tile showing contact sensor open (green) or closed (gray) and the values of the temperature sensor and battery level.
 
−
 
 
−
:[[File:DB48.png|link=https://docs.hubitat.com/File:DB48.png]]
 
−
 
 
−
'''Music-player'''
 
−
 
 
−
This is a multipurpose tile allowing for control of the music player commands, play, pause, previous, next, mute and set volume. It also displays the current track information.
 
−
 
 
−
:[[File:DB49.png|link=https://docs.hubitat.com/File:DB49.png]]
 
−
 
 
−
'''Outlet'''
 
−
 
 
−
This is a single use tile that turns on (green) or off (gray) the device via the switch attribute.
 
−
 
 
−
:[[File:DB50.png|link=https://docs.hubitat.com/File:DB50.png]]
 
−
 
 
−
'''Presence'''
 
−
 
 
−
This is a multipurpose tile that shows the presence (green) or not (gray) of a device and the battery level.
 
−
 
 
−
:[[File:DB51.png|link=https://docs.hubitat.com/File:DB51.png]]
 
−
 
 
−
'''Relay'''
 
−
 
 
−
This is a single use tile that shows the current state of a relay device. On is (green) and off is (gray). Taping the tile will send on/off.
 
−
 
 
−
:[[File:DB52.png|link=https://docs.hubitat.com/File:DB52.png]]
 
−
 
 
−
'''Shades'''
 
−
 
 
−
This is a single use tile that shows the current state of a shade device. Open is (green) and closed (gray). Taping the tile will send on/off.
 
−
 
 
−
:[[File:DB53.png|link=https://docs.hubitat.com/File:DB53.png]]
 
−
 
 
−
'''Smoke'''
 
−
 
 
−
This is a single use tile that shows if Smoke is detected by the device. The gray heart means everything is good, and the green “!” means smoke is detected.
 
−
 
 
−
:[[File:DB54.png|link=https://docs.hubitat.com/File:DB54.png]]
 
−
 
 
−
'''Switch'''
 
−
 
 
−
This is a single use tile that shows the current state of a switch, on (green) off (gray) and you can click the tile anywhere to turn the switch on/off.
 
−
 
 
−
:[[File:DB55.png|link=https://docs.hubitat.com/File:DB55.png]]
 
−
 
 
−
'''Temperature'''
 
−
 
 
−
This is a single use tile that shows the current temperature reported by the device assigned to it.
 
−
 
 
−
:[[File:DB56.png|link=https://docs.hubitat.com/File:DB56.png]]
 
−
 
 
−
'''Water'''
 
−
 
 
−
This is a multipurpose tile that shows a water sensor wet (green) or dry (gray) and the reported battery level and temperature
 
−
 
 
−
:[[File:DB57.png|link=https://docs.hubitat.com/File:DB57.png]]
 
−
 
 
−
'''Window'''
 
−
 
 
−
This is a single use tile that shows the open or closed state of a window.
 
−
 
 
−
:[[File:DB58.png|link=https://docs.hubitat.com/File:DB58.png]]
 

Revision as of 21:14, 30 October 2020

Hubitat® Dashboard app is a powerful and fast, grid-based tile solution for local and remote access. You can quickly create highly customizable Dashboards to monitor and control your devices from a phone, tablet or desktop. Multiple Dashboards can be assigned to specific users, allowing a custom layout for individual or multiple users. A convenient QR code capture grants access for the assigned Dashboards on a per user basis.

Installing Hubitat® Dashboard

  1. From the Hubitat Web Interface select Apps
    Install Built-In App 2.0.png
  2. Choose the Hubitat® Dashboard from the list of Hubitat Elevation® Built-In Apps
    Install Hubitat Dashboard.png

Configure Dashboard App Menu

  • Dashboard Menu - Once you have your first Dashboard created, you will have a list of Dashboards for quick access here. You can switch between Local and Cloud links using the two tab buttons.
  • Send Mobile App Link to Phone - This option allows you to text a link to someone to access the Hubitat® Dashboard Menu remotely.
    Create new dashboard.png

Advanced Options

  • Remove Hubitat Dashboard - Selecting this button will remove the Hubitat® Dashboard app app.
  • Allow new Dashboards to be created from Dashboard Menu - This option enables you to control if new Dashboards allowed to be created from the Dashboard menu.
  • Use Legacy Dashboards? - Allows you to go back to Dashboard 1.0 rendering. NOTE: If you add any new template tiles, this could cause legacy Dashboards to not render.

Creating a Dashboard

  1. Select Create a New Dashboard
  2. Give your Dashboard a name. This name will appear at the top of the Dashboard. Pick something descriptive such as the room your Dashboard is controlling, or its main purpose.
  3. Under the Links section, you will find Local and Cloud links to your new Dashboard. These are standard Web URLs that you can bookmark to allow direct and easy access to your Dashboards.  Local LAN Link is accessible inside your home, while on the same network and it features instant updates. Cloud Links are remotely accessible URLs that you can use to access your Dashboard from the internet, when you are outside your local network.New Dashboard.png
  4. Under Advanced, you can set some options that affect the access to your Dashboards.
    • You can change how fast the Dashboard should refresh via cloud and local links.  
    • You may set a Pin / Password to protect this Dashboard from loading.
    • You can set a numerical (numbers only ) PIN for Hubitat® Safety Monitor and for Modes.
    • It is also possible to disable access for this Dashboard from Cloud Links and/or from Local Links.
    • Lastly, you can set this Dashboard to “Read Only”, which will not allow any changes from inside the Dashboard app itself.
      Dashboard Advanced.png
  5. Next, decide if you want to authorize all devices to the Dashboard or just a select few devices. You can choose specific devices by disabling the Use all your devices switch. If you want to pick only a few devices, select Choose Devices and check the devices you want to see on your Dashboard. Limiting the devices in larger installs will speed up the loading of Dashboards.
  6. Choose “Done” and your first Dashboard is now installed.

Accessing Dashboards

  1. Now that we have your first Dashboard set up, let’s head over to it. Choose the local link and open your new Dashboard in a new window.
  2. You will now see the Getting Started dialog box, briefly explaining how Dashboard 2.0 functions.
    Getting Started Dashboard.png
  3. You have a couple options to get started. You can Manually Add Tiles (or just close this dialog) and get started, or you can select Auto Fill Grid and all your devices will be automatically added to the Dashboard with a default tile template.

Dashboard Builder

  1. You can also use the new Dashboard Builder by selecting the link Dashboard Builder in the menu bar as shown below. Dashboard Builder allows you to create a Dashboard based on the devices you have authorized and their specific “attributes”.  Select which ones you want to create, and you can then choose Build My Dashboard to create a quick and easy Dashboard that contains groups of each of these types of devices.
  2. Both Auto Fill Grid described in the previous section, and Dashboard Builder will automatically optimize their default Grid Size for the browser you are currently using. It is best to use the browser and device you intend to normally use with Hubitat® Dashboards, so this automated process can build a Dashboard specifically for your device and choice of web browser.
    Dashboard Builder.png

Add A Tile

  1. Select the + icon in the top right to open the Add A Tile dialog. Here you can set the number of Columns and Rows by either using the -/+ buttons, or clicking anywhere on the grid.
  2. You can also change the tile Width and Height to set how big the tile will be.
  3. Next, Pick a Device, then Pick a Template, and finally set the Options for that template.
  4. Select Add Tile and you will see the tile added to your Dashboard in the spot you selected. The Grid will change to gray in that spot where your Dashboard now has a tile.
    Add a Tile.png

Edit Tile

  1. You can edit any tile by clicking the 3 dot menu in the top right of any tile. This will open an editing window and allow you to move the tile around on the grid by selecting the -/+ or by clicking the grid layout to move your tile to that position on the Dashboard.
  2. You can quickly jump between editing of tiles by using the back and forward buttons in the menu bar to either side of Edit Tile ID:
  3. You can change the Device, the Template or any Options for the tile.
    Edit Tile.png
  4. Selecting History in the menu bar will open up a window with a list of activities for that device from the event table.
    Device History.png
  5. If you want to remove the tile, press the Delete Tile button.

Settings

  1. Selecting the gear icon in the top right opens up the Settings page for this Dashboard.
  2. There are 4 distinct options: Grid, Options, Templates and Advanced
    • Grid - You can change the grid size (columns and rows), font size, icon size, grid gap, as well as how rounded the corners are for all tiles. You may also paste in a URL for a background image, or set a color including a custom HTML value for the background of the grid.
      Options Grid.png
    • Options - Here you can change a variety of options for how your Dashboard will display (or will not display) information
      • Clock 12 Hour Mode (Turn off for 24 hour time) - Choose between 12 hour or 24 time display for any clock template or history
      • Date Format - Switch between MM/DD/YYYY and DD/MM/YYYY formats
      • Cloud and LAN Refresh Intervals - Set these to determine how fast the Dashboard will poll to show updates on screen.  NOTE: LAN refresh is only if a Dashboard can’t connect via websocket.  When connected via websockets, updates should be immediate.
      • Column Width and Row Height - Remove these to auto fit tiles to the grid, or change these to specific values to force the Dashboard to render these tiles as fixed sizes, forcing the Dashboard to scroll if it overflows the browser window.
      • Allow Logo Click - Disable this if you don’t want to use this option as a means to return to the Dashboard menu.
      • Hide 3 dots - This will hide all the 3 dot menu at the top-right of each tile. You will need to re-enable the 3 dot menu if you want to edit tiles. NOTE: This does not make the tiles read only, and the option can be still be set from inside the Dashboard App settings in the Hubitat Web Interface.
      • Hide Tile Template Names - This allows you to remove the names that are at the top of most templates.
      • Hide Icon Helper Text - Hides the text under each icon that indicates the attribute value.
      • Hide Device History - Used to remove the option to view device history in the tile details area.
      • Do Not Use Default Tile Colors - Turning this on will disable the default colors for templates.
        Options.png

Templates

  • In this section you can change the Color, Background Color and Custom Icons for each state available for a template.
    Templates.png

Advanced

  • Layout - This area allows you to copy and paste in layouts or make direct edits to your options, layout and custom colors.  Quickly share custom colors or layouts using the code from this window.
    Advanced Layout.png
  • Devices - This area allows you to see a list of authorized devices, the current states and history (if enabled) for each device.  This is helpful to troubleshoot if a device is reporting proper states.
Retrieved from "https://docs.hubitat.com/index.php?title=Hubitat™_Dashboard_v1&oldid=3216"