Difference between revisions of "Hubitat Diagnostic Tool"
(Updated link for getting latest Diagnostic update tool) (Tag: Visual edit) |
(Updated for Diag tool 1.0.81) (Tag: Visual edit) |
||
| Line 5: | Line 5: | ||
#Navigate to '''http://[Your Hub IP]:8081/''' and you will see the Hubitat Diagnostic Tool* main page. | #Navigate to '''http://[Your Hub IP]:8081/''' and you will see the Hubitat Diagnostic Tool* main page. | ||
#*'''NOTE''': (Replace [Your Hub IP] with the IP address of your hub) | #*'''NOTE''': (Replace [Your Hub IP] with the IP address of your hub) | ||
| − | #Choose the option you require. If you are not already logged in, you will be prompted to log in.[[File:Diagnostic Tool.png|none|thumb| | + | #Choose the option you require. If you are not already logged in, you will be prompted to log in.[[File:Diagnostic Tool 1.0.81.png|none|thumb|1043x1043px]] |
| − | #*'''IMPORTANT''': For your privacy protection, the login is set to timeout periodically. If you see '''Error 401''' displayed, please '''Log Out''' of the Diagnostic Tool, then close all your browser's windows and log back in using the hub's MAC address. The password is the MAC address which you can find by going to '''Settings''' in your Hubitat Web Interface and choosing [[Hub Details]]. If you are unable to access your hub from the Hubitat Web Interface, you can find the MAC address printed on a sticker on the bottom of your hub.[[File:Diag | + | #*'''IMPORTANT''': For your privacy protection, the login is set to timeout periodically. If you see '''Error 401''' displayed, please '''Log Out''' of the Diagnostic Tool, then close all your browser's windows and log back in using the hub's MAC address. The password is the MAC address which you can find by going to '''Settings''' in your Hubitat Web Interface and choosing [[Hub Details]]. If you are unable to access your hub from the Hubitat Web Interface, you can find the MAC address printed on a sticker on the bottom of your hub.[[File:Diag Tool Login v2.png|none|thumb|378x378px]][[File:Hub Diag Tool Login v2.png|none|thumb|378x378px]] |
===Restore Previous Version=== | ===Restore Previous Version=== | ||
Returns the hub platform to the previous version with the existing database intact. If you experience issues with your hub and suspect a recent update, this is the first step to test for issues related to a recent release. | Returns the hub platform to the previous version with the existing database intact. If you experience issues with your hub and suspect a recent update, this is the first step to test for issues related to a recent release. | ||
| − | [[File:Diag Tool-Restore Previous.png|none|thumb| | + | [[File:Diag Tool-Restore Previous v2.png|none|thumb|383x383px]] |
| − | [[File: | + | [[File:Roll Back to Previous v2.png|none|thumb|414x414px]] |
===Set Hub Date and Time=== | ===Set Hub Date and Time=== | ||
| Line 28: | Line 28: | ||
If the Hubitat Web Interface is unresponsive, you can try shutting down your hub from the diagnostic tool. | If the Hubitat Web Interface is unresponsive, you can try shutting down your hub from the diagnostic tool. | ||
| − | '''IMPORTANT''': Make sure the light on the front of your hub is <span style="color: red;;">'''Red'''</span>, and then unplug your hub from its power source for a '''minimum of 30 seconds''' before plugging it back in. | + | '''IMPORTANT''': Make sure the light on the front of your hub is <span style="color: red;;">'''Red'''</span>, and then unplug your hub from its power source for a '''minimum of 30 seconds''' before plugging it back in. To avoid stressing the micro USB connection, it is recommended that power be removed from the hub by unplugging the power adapter from the outlet instead of the hub. |
[[File:Diag tool-Shutdown hub.png|none|thumb|391x391px]] | [[File:Diag tool-Shutdown hub.png|none|thumb|391x391px]] | ||
[[File:Shutdown hub confirmation.png|none|thumb|376x376px]] | [[File:Shutdown hub confirmation.png|none|thumb|376x376px]] | ||
| Line 39: | Line 39: | ||
===Soft Reset=== | ===Soft Reset=== | ||
A soft reset will remove the main hub's database, allowing users to restore a previous backup. This process does not reset the Zigbee or Z-Wave radios. You could restore a backup after performing a soft reset, so you can continue to control your existing devices. See the [[Soft Reset|Soft Reset documentation]] for more detail. | A soft reset will remove the main hub's database, allowing users to restore a previous backup. This process does not reset the Zigbee or Z-Wave radios. You could restore a backup after performing a soft reset, so you can continue to control your existing devices. See the [[Soft Reset|Soft Reset documentation]] for more detail. | ||
| − | [[File:Diag Tool-Soft Reset.png|none|thumb| | + | [[File:Diag Tool-Soft Reset v2.png|none|thumb|383x383px]] |
[[File:Soft reset confirmation.png|none|thumb|495x495px]] | [[File:Soft reset confirmation.png|none|thumb|495x495px]] | ||
| − | === | + | ===Download Backups=== |
| − | + | If the Hub Web Interface is not accessible, you may download previous backups stored on the hub for restore following a '''Soft Reset''' of the hub. | |
| − | |||
| − | |||
| − | |||
===Missing Diagnostic Tool=== | ===Missing Diagnostic Tool=== | ||
| − | The following two steps are required if you you do not have the newest "Hubitat Diagnostic Tool" installed, or otherwise don't see the ''' | + | The following two steps are required if you you do not have the newest "Hubitat Diagnostic Tool" installed, or otherwise don't see the '''Download Backups''' option when accessing it from port 8081. |
#Navigate to '''http://[Your Hub IP]/hub/cloud/updateDiagnosticTool''' and it will install the latest Hubitat Diagnostic Tool. | #Navigate to '''http://[Your Hub IP]/hub/cloud/updateDiagnosticTool''' and it will install the latest Hubitat Diagnostic Tool. | ||
#*'''NOTE''': Replace [Your Hub IP] with the IP address of your hub. | #*'''NOTE''': Replace [Your Hub IP] with the IP address of your hub. | ||
#Proceed to '''http://[Your Hub IP]:8081''' and then continue following the steps in this document. | #Proceed to '''http://[Your Hub IP]:8081''' and then continue following the steps in this document. | ||
Revision as of 23:08, 17 December 2020
The Hubitat Diagnostic Tool is a built-in application of every Hubitat Elevation™ hub, which runs independently of the main platform and provides owners with helpful tools to restore the hub platform, set the date and time, reboot, safely shutdown, temporarily disable apps, drivers or devices that may be causing issues, or to reset the hub. While several of these functions are accessible through the Hubitat Web Interface, they are duplicated here in situations where accessing the Hubitat Web interface isn't possible.
Contents
Accessing the Hubitat Diagnostic Tool
- Navigate to http://[Your Hub IP]:8081/ and you will see the Hubitat Diagnostic Tool* main page.
- NOTE: (Replace [Your Hub IP] with the IP address of your hub)
- Choose the option you require. If you are not already logged in, you will be prompted to log in.
- IMPORTANT: For your privacy protection, the login is set to timeout periodically. If you see Error 401 displayed, please Log Out of the Diagnostic Tool, then close all your browser's windows and log back in using the hub's MAC address. The password is the MAC address which you can find by going to Settings in your Hubitat Web Interface and choosing Hub Details. If you are unable to access your hub from the Hubitat Web Interface, you can find the MAC address printed on a sticker on the bottom of your hub.
Restore Previous Version
Returns the hub platform to the previous version with the existing database intact. If you experience issues with your hub and suspect a recent update, this is the first step to test for issues related to a recent release.
Set Hub Date and Time
If you are unable to synchronize the hub date and time with your browser from the Hubitat Web Interface, you can do it from the diagnostic tool.
- Press the Update Time button to set your hub time, to be in sync with your browser time.
- Select the refresh button to see the change.
Reboot Hub
If the Hubitat Web Interface is unresponsive, you can try rebooting from the diagnostic tool.
Shutdown Hub
If the Hubitat Web Interface is unresponsive, you can try shutting down your hub from the diagnostic tool.
IMPORTANT: Make sure the light on the front of your hub is Red, and then unplug your hub from its power source for a minimum of 30 seconds before plugging it back in. To avoid stressing the micro USB connection, it is recommended that power be removed from the hub by unplugging the power adapter from the outlet instead of the hub.
Safe Mode
If you find yourself in the situation where an app such as a Rule Machine® rule has been mistakenly built in a way that creates a loop and cannot be deleted from the Hubitat Web Interface, the hub may be restarted into Safe Mode. This disables User and Built-In apps and devices, the scheduler is halted, the listener for LAN messages is stopped, connection to the Hubitat cloud is disabled, the UPnP listener is halted, and all Zigbee and Z-Wave devices are disabled.
Soft Reset
A soft reset will remove the main hub's database, allowing users to restore a previous backup. This process does not reset the Zigbee or Z-Wave radios. You could restore a backup after performing a soft reset, so you can continue to control your existing devices. See the Soft Reset documentation for more detail.
Download Backups
If the Hub Web Interface is not accessible, you may download previous backups stored on the hub for restore following a Soft Reset of the hub.
Missing Diagnostic Tool
The following two steps are required if you you do not have the newest "Hubitat Diagnostic Tool" installed, or otherwise don't see the Download Backups option when accessing it from port 8081.
- Navigate to http://[Your Hub IP]/hub/cloud/updateDiagnosticTool and it will install the latest Hubitat Diagnostic Tool.
- NOTE: Replace [Your Hub IP] with the IP address of your hub.
- Proceed to http://[Your Hub IP]:8081 and then continue following the steps in this document.
