Difference between revisions of "Soft Reset"
(Tag: Visual edit) |
|||
| Line 1: | Line 1: | ||
{{Top}} | {{Top}} | ||
| − | === '''<big>What is a Soft Reset?</big>''' === | + | ==='''<big>What is a Soft Reset?</big>'''=== |
<big>A soft reset erases the main database on your hub, which contains your settings, device list, custom code, and other configuration. It does ''not'' reset the Z-Wave or Zigbee radios. It is generally a safe procedure to perform, and '''if you download a backup and then restore it afterwards''', your hub should function as before. If you suspect database corruption, a soft reset and restore can be a useful troubleshooting step.</big> | <big>A soft reset erases the main database on your hub, which contains your settings, device list, custom code, and other configuration. It does ''not'' reset the Z-Wave or Zigbee radios. It is generally a safe procedure to perform, and '''if you download a backup and then restore it afterwards''', your hub should function as before. If you suspect database corruption, a soft reset and restore can be a useful troubleshooting step.</big> | ||
| − | <big>NOTE: | + | <big>'''NOTE:''' A soft reset affects only the hub database, as described above. To reset ''all'' possible hub components, you can reset the radios (from '''Settings > Z-Wave Details''' and '''Settings > Zigbee Details''') and un-register your hub (if registered to a cloud account; check my.hubitat.com). These extra steps are not necessary in most cases, and these additional resets are no longer considered a "soft reset." Unlike a simple soft reset, devices will need to be re-paired to function with the hub again.</big> |
| − | === '''<big>How to Perform a Soft Reset</big>''' === | + | ==='''<big>How to Perform a Soft Reset</big>'''=== |
#<big>Navigate to '''http://[Your Hub IP]:8081/''' and you will see the Hubitat Diagnostic Tool main page. (If your hub is fully functional, you can also access the diagnostic tool from '''Settings > Diagnostic Tool'''.)</big> | #<big>Navigate to '''http://[Your Hub IP]:8081/''' and you will see the Hubitat Diagnostic Tool main page. (If your hub is fully functional, you can also access the diagnostic tool from '''Settings > Diagnostic Tool'''.)</big> | ||
#*<big>'''NOTE''': (Replace [Your Hub IP] with the ip address of your hub)</big> | #*<big>'''NOTE''': (Replace [Your Hub IP] with the ip address of your hub)</big> | ||
| − | #<big>Choose '''Soft Reset'''</big>[[File:Hub Diagnostics v1081 Soft Reset.png|none|thumb|1043x1043px|link=https://docs.hubitat.com/images/0/0e/Hub_Diagnostics_v1081_Soft_Reset.png | + | #<big>Choose '''Soft Reset'''</big>[[File:Hub Diagnostics v1081 Soft Reset.png|none|thumb|1043x1043px|link=https://docs.hubitat.com/images/0/0e/Hub_Diagnostics_v1081_Soft_Reset.png ]] |
| − | ]] | + | #<big>If you are not already logged in, you will be prompted to log in. The password is the MAC address which is printed on a sticker on the bottom of your hub, but you may also find it by going to '''Settings''' in the sidebar of your hub and choose [[Hub Details|'''Hub Details'''.]]</big>[[File:Hub Diag Tool Login v2.png|none|thumb|403x403px|link=https://docs.hubitat.com/images/1/16/Hub_Diag_Tool_Login_v2.png ]] |
| − | #<big>If you are not already logged in, you will be prompted to log in. The password is the MAC address which is printed on a sticker on the bottom of your hub, but you may also find it by going to '''Settings''' in the sidebar of your hub and choose [[Hub Details|'''Hub Details'''.]]</big>[[File:Hub Diag Tool Login v2.png|none|thumb|403x403px|link=https://docs.hubitat.com/images/1/16/Hub_Diag_Tool_Login_v2.png | + | #<big>The Soft Reset page will open and you will need to type "soft reset" into the input box and then press the '''Soft Reset''' button.</big>[[File:Soft reset confirmation.png|none|thumb|495x495px|link=https://docs.hubitat.com/images/1/11/Soft_reset_confirmation.png ]] |
| − | ]] | ||
| − | #<big>The Soft Reset page will open and you will need to type "soft reset" into the input box and then press the '''Soft Reset''' button.</big>[[File:Soft reset confirmation.png|none|thumb|495x495px|link=https://docs.hubitat.com/images/1/11/Soft_reset_confirmation.png | ||
| − | ]] | ||
#<big>Once the Soft Reset has completed, the hub will restart and you will automatically be redirected to the setup page.</big> | #<big>Once the Soft Reset has completed, the hub will restart and you will automatically be redirected to the setup page.</big> | ||
#*<big>'''NOTE''': For your privacy protection, the login is set to time out 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. You can find you hub MAC address on the bottom of your hub, or go to [[Hub Details|'''Hub Details''']] for information on how to find your hub MAC address from the Hubitat Web Interface.</big> | #*<big>'''NOTE''': For your privacy protection, the login is set to time out 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. You can find you hub MAC address on the bottom of your hub, or go to [[Hub Details|'''Hub Details''']] for information on how to find your hub MAC address from the Hubitat Web Interface.</big> | ||
| Line 24: | Line 21: | ||
#<big>There will be a link at the bottom of the "Get Started" page that reads, '''Restore from Backup?'''</big> | #<big>There will be a link at the bottom of the "Get Started" page that reads, '''Restore from Backup?'''</big> | ||
| − | #<big>Choose that link and follow the directions here found under '''[[Backup and Restore#How to restore the database from backup|How to restore from backup]]'''</big>[[File:Restore from previous backup soft reset.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/3/31/Restore_from_previous_backup_soft_reset.png | + | #<big>Choose that link and follow the directions here found under '''[[Backup and Restore#How to restore the database from backup|How to restore from backup]]'''</big>[[File:Restore from previous backup soft reset.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/3/31/Restore_from_previous_backup_soft_reset.png ]][[File:Hub restoring backup.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/d/d2/Restoring_hub_from_database_backup.png]] |
| − | ]][[File:Hub restoring backup.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/d/d2/Restoring_hub_from_database_backup.png]] | ||
#<big>Select '''Settings''' page in the sidebar.</big> | #<big>Select '''Settings''' page in the sidebar.</big> | ||
#<big>Choose [[Care and Maintenance#How to Reboot Your Hub|'''Reboot Hub'''.]]</big> | #<big>Choose [[Care and Maintenance#How to Reboot Your Hub|'''Reboot Hub'''.]]</big> | ||
| − | NOTE: Database backups do not include File Manager files. These should be backed up and restored separately, if so desired. | + | NOTE: Database backups do not include File Manager files. These should be backed up and restored separately, if so desired. Logs are also not part of the hub database and will not be reset. |
Revision as of 00:04, 28 August 2022
What is a Soft Reset?
A soft reset erases the main database on your hub, which contains your settings, device list, custom code, and other configuration. It does not reset the Z-Wave or Zigbee radios. It is generally a safe procedure to perform, and if you download a backup and then restore it afterwards, your hub should function as before. If you suspect database corruption, a soft reset and restore can be a useful troubleshooting step.
NOTE: A soft reset affects only the hub database, as described above. To reset all possible hub components, you can reset the radios (from Settings > Z-Wave Details and Settings > Zigbee Details) and un-register your hub (if registered to a cloud account; check my.hubitat.com). These extra steps are not necessary in most cases, and these additional resets are no longer considered a "soft reset." Unlike a simple soft reset, devices will need to be re-paired to function with the hub again.
How to Perform a Soft Reset
- Navigate to http://[Your Hub IP]:8081/ and you will see the Hubitat Diagnostic Tool main page. (If your hub is fully functional, you can also access the diagnostic tool from Settings > Diagnostic Tool.)
- NOTE: (Replace [Your Hub IP] with the ip address of your hub)
- Choose Soft Reset
- If you are not already logged in, you will be prompted to log in. The password is the MAC address which is printed on a sticker on the bottom of your hub, but you may also find it by going to Settings in the sidebar of your hub and choose Hub Details.
- The Soft Reset page will open and you will need to type "soft reset" into the input box and then press the Soft Reset button.
- Once the Soft Reset has completed, the hub will restart and you will automatically be redirected to the setup page.
- NOTE: For your privacy protection, the login is set to time out 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. You can find you hub MAC address on the bottom of your hub, or go to Hub Details for information on how to find your hub MAC address from the Hubitat Web Interface.
Restoring a previous database
The following two steps are required if you are restoring previous hub's settings from a backup.
- There will be a link at the bottom of the "Get Started" page that reads, Restore from Backup?
- Choose that link and follow the directions here found under How to restore from backup
- Select Settings page in the sidebar.
- Choose Reboot Hub.
NOTE: Database backups do not include File Manager files. These should be backed up and restored separately, if so desired. Logs are also not part of the hub database and will not be reset.
