Difference between revisions of "Hubitat® Dashboard"

From Hubitat Documentation
Jump to: navigation, search
(Image relinking)
(→‎Creating Your Dashboard)
Line 3: Line 3:
 
==Creating Your Dashboard==
 
==Creating Your Dashboard==
  
−
#Load the Hubitat<sup>®</sup> Dashboard App in the Hubitat Web Interface.
+
#Load the Hubitat<sup>®</sup> Dashboard App in the Hubitat Web Interface.[[File:Add Built-in App.png|none|thumb]]
 +
#Scroll to "Hubitat<sup>®</sup> Dashboard" and click it to install.[[File:Dashboard Install.png|none|thumb]]Dashboard App Menu  [[File:Create new dashboard.png]]  '''Send Mobile App Link to Phone''' option allows you to text a link to someone to access the Hubitat Dashboard Menu remotely.  '''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  '''Advanced Options'''  '''Remove Hubitat Dashboard''' allows you to remove this app.  '''Allow new Dashboards to be created from Dashboard Menu.''' This option allows you to control if you want to allow new dashboards to be created or not from the dashboard menu.  '''Use Legacy Dashboards?''' This allows you to go back to Dashboard 1.0 rendering.  Keep in mind if you add any new template tiles this could cause the legacy dashboard not to render.
 
#Click on ''Create a New Dashboard''
 
#Click on ''Create a New Dashboard''
−
#:[[File:DB1.png]]
+
#Give your dashboard a name. This name will appear at the top of the dashboard. Pick something descriptive such as the room this dashboard is controlling or its main purpose.
−
#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:New Dashboard.png]] In '''Links''' you have your local and cloud links to your new dashboard.  These are standard Web URLs that you can bookmark to directly access your dashboards.  Local LAN link is accessible inside your house while on the same network and features instant updates.  Cloud Links are remotely accessible URLs that you can use to access your dashboard from outside your network. Under '''Advanced''' you can set some options you can’t change in the actual dashboard.[[File:Dashboard Advanced.png|none|thumb]]You can change how fast the dashboard should refresh via cloud and local links.    You can set a Pin / Password to protect this dashboard from loading. You can also set numerical (only numbers) PIN for HSM and Modes.  You can also turn off access for this dashboard from the Cloud and/or Local links. Lastly, you can set this dashboard to “Read Only” which will not allow any changes from inside the dashboard app itself.
−
#:[[File:DB2.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 toggling the ''Use all your devices'' switch to ''Off''. 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 dashboard.
−
#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]]
 
−
#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
 
−
 
 
−
#Hubitat<sup>®</sup> 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.
 
−
#:[[File:DB4.png|500x500px]]
 
−
#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]]
 
−
#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]]
 
−
#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]]
 
 
#Click “Done” and your first dashboard is installed.
 
#Click “Done” and your first dashboard is installed.
−
 
−
'''Import/Export Dashboard Layout'''
 
−
 
−
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.
 
−
 
−
'''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.
 
−
 
−
:[[File:DB8.png]]
 
−
 
−
Once you have pasted in a different layout, tab out of the box and you will see this:
 
−
 
−
:[[File:DB69.png]]
 
−
 
−
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.
 
−
 
−
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.
 
−
 
−
When importing someone else’s layout, exercise caution and realize you will need to update each tile with your own devices.
 
  
 
Overall, Hubitat<sup>®</sup> 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.
 
Overall, Hubitat<sup>®</sup> 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.
  
−
==Loading and Editing Your Dashboard==
+
==Accessing Dashboards==
−
 
 
−
'''Loading Your Dashboard(s)'''
 
−
 
 
−
#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.
 
−
#:[[File:DB8.png]]
 
−
 
 
−
'''Customizing Your dashboard'''
 
−
 
 
−
#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.
 
−
#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.
 
−
#:[[File:DB10.png]]
 
−
 
 
−
'''Change the Grid Size'''
 
−
 
 
−
#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.
 
−
#:[[File:DB12.png|161x161px]]
 
−
#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|220x220px]]
 
−
#:[[File:DB14.png]]
 
−
#Tap ''Update Grid'' to save your changes and see them on the dashboard.
 
−
 
 
−
'''Add A Tile'''
 
−
 
 
−
#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.
 
−
#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.
 
−
#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|196x196px]]
 
−
#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|196x196px]]
 
−
#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|259x259px]]
 
−
 
 
−
'''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|166x166px]]
 
−
#In the pop-up window, select the template you would like to edit.
 
−
#:[[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]]
 
−
#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]]
 
−
#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<sup>®</sup> 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]]
 
−
 
 
−
'''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|195x195px]]
 
−
:[[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|225x225px]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''Carbon-dioxide'''
 
−
 
 
−
This is a single use tile that displays the reported carbon dioxide (CO2) levels in parts per million (ppm)
 
−
 
 
−
:[[File:DB30.png|259x259px]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''Clock-date'''
 
−
 
 
−
This is a special tile that displays your local browser time with seconds along with the current date.
 
−
 
 
−
:[[File:DB32.png]]
 
−
 
 
−
'''Clock'''
 
−
 
 
−
This is a special tile that displays your local browser time with seconds.
 
−
 
 
−
:[[File:DB33.png|229x229px]]
 
−
 
 
−
'''Contact'''
 
−
 
 
−
This is a single use tile that displays the contact attribute of a device. Green means open, gray means closed.
 
−
 
 
−
:[[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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''Energy'''
 
−
 
 
−
This is a single use tile that displays the energy attribute reported from the device.
 
−
 
 
−
:[[File:DB38.png|259x259px]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''Humidity'''
 
−
 
 
−
This is a single use tile that displays the humidity attribute as a percentage.
 
−
 
 
−
:[[File:DB40.png|227x227px]]
 
−
 
 
−
'''Illuminance'''
 
−
 
 
−
This is a single use tile that displays the light level in lux from the device.
 
−
 
 
−
:[[File:DB41.png|226x226px]]
 
−
 
 
−
'''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'''
 
−
 
 
−
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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
 
−
 
 
−
'''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]]
+
'''Accessing Your Dashboard(s)'''
  
−
'''Music-player'''
+
Now that we have your first dashboard set up, let’s head over to it. Click the local link and open your new dashboard in a new window.
  
−
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.
+
You will now see the Getting Started dialog box.
 +
[[File:Getting Started Dashboard.png|none|thumb]]
 +
This will tell you a bit about how Dashboard 2.0 works.  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.
  
−
:[[File:DB49.png]]
+
You can also use the new “Dashboard Builder” by clicking on it in the menu bar.
 +
[[File:Dashboard Builder.png|none|thumb]]
 +
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 click “Build My Dashboard” to create a quick and easy dashboard that contains groups of each of these types of devices.
  
−
'''Outlet'''
+
Both Auto Fill Grid and Dashboard Builder automatically optimize their default Grid Size for the browser you are currently using.  It is best to use the browser you intend on using so this process builds a dashboard specifically for your device.
  
−
This is a single use tile that turns on (green) or off (gray) the device via the switch attribute.
+
== '''Add A Tile''' ==
 +
Clicking on the “+” icon in the top right opens the '''Add A Tile''' dialog.
 +
[[File:Add a Tile.png|none|thumb]]
 +
This allows you to set the column and row by either using the -/+ buttons or clicking anywhere on the grid.  
  
−
:[[File:DB50.png]]
+
You can also change the tile width and/or tile height to set how big the tile will be.
  
−
'''Presence'''
+
Then pick a device, a template and set the options for that template.  Finally click Add Tile and you will see the tile added to your Dashboard in the spot you selected.
  
−
This is a multipurpose tile that shows the presence (green) or not (gray) of a device and the battery level.
+
You will notice the Grid should change to gray in that spot where the grid now has a tile.
  
−
:[[File:DB51.png|496x496px]]
+
== '''Edit Tile''' ==
 +
You can edit any tile by clicking the 3 dot menu in the top right of any tile.
 +
[[File:Edit Tile.png|none|thumb]]
 +
This will open up and allow you to move the tile around on the grid by clicking the -/+ or the grid layout and you will notice the tile will move to that spot.
  
−
'''Relay'''
+
You can quickly jump between tiles by using the back and forward buttons next to “Edit Tile: X”
  
−
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.
+
“History” will open up a list of activities for that device from the event table.
 +
[[File:Device History.png|none|thumb]]
 +
You can change the Device and/or template or change any Options for the tile.
  
−
:[[File:DB52.jpg|526x526px]]
+
If you want to remove the tile, click the “Delete Tile” button.
  
−
'''Shades'''
+
== '''Settings''' ==
 +
Clicking the gear icon in the top right opens up the Settings page for this dashboard.
  
−
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.
+
There are 4 distinct options: Grid, Options, Templates and Advanced
  
−
:[[File:DB53.png]]
+
=== '''Grid''' ===
 +
[[File:Options Grid.png|none|thumb]]
 +
You can change the grid size (columns and rows), font size, icon size, grid gap and how rounded the corners are for all tiles
  
−
'''Smoke'''
+
You can also paste in a URL for a background image or set a color including a custom HTML value for the background of the grid.
  
−
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.
+
=== '''Options''' ===
 +
[[File:Options.png|none|thumb]]
 +
Here you can change a variety of options on how your dashboard will display (or not) information.
  
−
:[[File:DB54.png|456x456px]]
+
'''Clock 12 Hour mode''', turn off for 24 hour time display in any clock template or history
  
−
'''Switch'''
+
'''Date Format''', switch between MM/DD and DD/MM formats
  
−
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.
+
'''Cloud and LAN''' refresh intervals, set these to determine how fast it polls.  NOTE: LAN refresh is only if dashboard can’t connect via websocket.  When connected via websocket, updates should be immediate.
  
−
:[[File:DB55.png|458x458px]]
+
'''Column Width and Row Height'''.  Remove these to auto fit tiles to grid, or change these to specific values to force the dashboard to render these tiles as fixed sizes and this will allow the dashboard to scroll if it overflows the browser window.
  
−
'''Temperature'''
+
'''Allow Logo Click'''.  Disable this if you don’t want the option to return to the dashboard menu.
  
−
This is a single use tile that shows the current temperature reported by the device assigned to it.
+
'''Hide 3 dots'''.  This will hide all 3 dot options in tiles.  You will need to re-enable these if you want to edit tiles (NOTE: This is not read only, that can be set inside the Dashboard App settings in the Hubitat Web Interface)
  
−
:[[File:DB56.png|224x224px]]
+
'''Hide Tile Template Names.'''  This allows you to remove the names that are at the top of most templates.
  
−
'''Water'''
+
'''Hide Icon Helper Text.'''  This will hide the text under each icon that indicates the attribute value.
  
−
This is a multipurpose tile that shows a water sensor wet (green) or dry (gray) and the reported battery level and temperature
+
'''Hide Device History.''' This will remove the option to view device history in the tile details area.
  
−
:[[File:DB57.png]]
+
'''Do Not Use Default Tile Colors'''.  Turning this on will disable the default colors for templates.
  
−
'''Window'''
+
=== '''Templates''' ===
 +
[[File:Templates.png|none|thumb]]
 +
In this area you can change the Color, Background Color and Custom Icons for each state available for a template.
  
−
This is a single use tile that shows the open or closed state of a window.
+
=== Advanced - Layout ===
 +
[[File:Advanced Layout.png|none|thumb]]
 +
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 this area.
  
−
:[[File:DB58.png]]
+
=== Advanced - Devices ===
 +
[[File:Advanced Devices.png|none|thumb]]
 +
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.

Revision as of 15:18, 26 March 2019

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

  1. Load the Hubitat® Dashboard App in the Hubitat Web Interface.
    Add Built-in App.png
  2. Scroll to "Hubitat® Dashboard" and click it to install.
    Dashboard Install.png
    Dashboard App Menu Create new dashboard.png Send Mobile App Link to Phone option allows you to text a link to someone to access the Hubitat Dashboard Menu remotely. 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 Advanced Options Remove Hubitat Dashboard allows you to remove this app. Allow new Dashboards to be created from Dashboard Menu. This option allows you to control if you want to allow new dashboards to be created or not from the dashboard menu. Use Legacy Dashboards? This allows you to go back to Dashboard 1.0 rendering.  Keep in mind if you add any new template tiles this could cause the legacy dashboard not to render.
  3. Click on Create a New Dashboard
  4. Give your dashboard a name. This name will appear at the top of the dashboard. Pick something descriptive such as the room this dashboard is controlling or its main purpose.
    New Dashboard.png In Links you have your local and cloud links to your new dashboard.  These are standard Web URLs that you can bookmark to directly access your dashboards.  Local LAN link is accessible inside your house while on the same network and features instant updates.  Cloud Links are remotely accessible URLs that you can use to access your dashboard from outside your network. Under Advanced you can set some options you can’t change in the actual dashboard.
    Dashboard Advanced.png
    You can change how fast the dashboard should refresh via cloud and local links.   You can set a Pin / Password to protect this dashboard from loading. You can also set numerical (only numbers) PIN for HSM and Modes. You can also turn off access for this dashboard from the Cloud and/or Local links. Lastly, you can set this dashboard to “Read Only” which will not allow any changes from inside the dashboard app itself.
  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 toggling the Use all your devices switch to Off. 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 dashboard.
  6. Click “Done” and your first dashboard is installed.

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.

Accessing Dashboards

Accessing Your Dashboard(s)

Now that we have your first dashboard set up, let’s head over to it. Click the local link and open your new dashboard in a new window.

You will now see the Getting Started dialog box.

Getting Started Dashboard.png

This will tell you a bit about how Dashboard 2.0 works.  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 also use the new “Dashboard Builder” by clicking on it in the menu bar.

Dashboard Builder.png

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 click “Build My Dashboard” to create a quick and easy dashboard that contains groups of each of these types of devices.

Both Auto Fill Grid and Dashboard Builder automatically optimize their default Grid Size for the browser you are currently using.  It is best to use the browser you intend on using so this process builds a dashboard specifically for your device.

Add A Tile

Clicking on the “+” icon in the top right opens the Add A Tile dialog.

Add a Tile.png

This allows you to set the column and row by either using the -/+ buttons or clicking anywhere on the grid.  

You can also change the tile width and/or tile height to set how big the tile will be.

Then pick a device, a template and set the options for that template.  Finally click Add Tile and you will see the tile added to your Dashboard in the spot you selected.

You will notice the Grid should change to gray in that spot where the grid now has a tile.

Edit Tile

You can edit any tile by clicking the 3 dot menu in the top right of any tile.

Edit Tile.png

This will open up and allow you to move the tile around on the grid by clicking the -/+ or the grid layout and you will notice the tile will move to that spot.

You can quickly jump between tiles by using the back and forward buttons next to “Edit Tile: X”

“History” will open up a list of activities for that device from the event table.

Device History.png

You can change the Device and/or template or change any Options for the tile.

If you want to remove the tile, click the “Delete Tile” button.

Settings

Clicking the gear icon in the top right opens up the Settings page for this dashboard.

There are 4 distinct options: Grid, Options, Templates and Advanced

Grid

Options Grid.png

You can change the grid size (columns and rows), font size, icon size, grid gap and how rounded the corners are for all tiles

You can 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

Options.png

Here you can change a variety of options on how your dashboard will display (or not) information.

Clock 12 Hour mode, turn off for 24 hour time display in any clock template or history

Date Format, switch between MM/DD and DD/MM formats

Cloud and LAN refresh intervals, set these to determine how fast it polls.  NOTE: LAN refresh is only if dashboard can’t connect via websocket.  When connected via websocket, updates should be immediate.

Column Width and Row Height.  Remove these to auto fit tiles to grid, or change these to specific values to force the dashboard to render these tiles as fixed sizes and this will allow the dashboard to scroll if it overflows the browser window.

Allow Logo Click.  Disable this if you don’t want the option to return to the dashboard menu.

Hide 3 dots.  This will hide all 3 dot options in tiles.  You will need to re-enable these if you want to edit tiles (NOTE: This is not read only, that can be set 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.  This will hide the text under each icon that indicates the attribute value.

Hide Device History. This will 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.

Templates

Templates.png

In this area you can change the Color, Background Color and Custom Icons for each state available for a template.

Advanced - Layout

Advanced Layout.png

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 this area.

Advanced - Devices

Advanced Devices.png

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&oldid=1780"