Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add troubleshooting menu to settings, with Thread credentials sync #3614

Merged
merged 2 commits into from
Jun 30, 2023

Conversation

jpelgrom
Copy link
Member

@jpelgrom jpelgrom commented Jun 28, 2023

Summary

Implements a troubleshooting/developer settings menu in the app settings to implement #3583

The troubleshooting menu contains options you'd find in Android's developer settings menu, and should not be in the main app settings list. Viewing logs and enabling WebView debugging is moved to this menu.

Thread credentials sync will trigger the normal sync cycle and show the outcome to help users with troubleshooting Thread/Matter commissioning issues.

Screenshots

New item in the main app settings:

Light Dark
Settings header 'Need help?' followed by two items: 'Documentation' and 'Troubleshooting: Logs and other tools to diagnose issues', light mode Settings header 'Need help?' followed by two items: 'Documentation' and 'Troubleshooting: Logs and other tools to diagnose issues', dark mode

The troubleshooting menu contains the previously mentioned three items:

Light Dark
App settings screen titled 'Troubleshooting' with 3 options: 'Show and Share Logs', 'WebView Remote Debugging' and 'Sync Thread credentials', light mode App settings screen titled 'Troubleshooting' with 3 options: 'Show and Share Logs', 'WebView Remote Debugging' and 'Sync Thread credentials', dark mode

Syncing Thread credentials has multiple possible outcomes, a few examples:
(edit: messages have been updated to be less technical, view strings.xml)

Alert 'The connected Home Assistant server does not support Thread' Alert 'Home Assistant and this device may use different credentials (device prefers credentials for: NEST-PAN-8E8F)' Alert 'Home Assistant and this device use the same credentials'

Link to pull request in Documentation repository

Documentation: home-assistant/companion.home-assistant#950

Any other notes

Thread specific testing note: the debug app cannot manage HA credentials added by the production app so you may need to reset Play Services storage to get different results

 - Add a troubleshooting menu to the app settings which includes logs/debugging settings
 - Add an option to manually sync Thread credentials and view the result
@jpelgrom jpelgrom linked an issue Jun 28, 2023 that may be closed by this pull request
@jpelgrom
Copy link
Member Author

@agners I think this sync + show result option should help with troubleshooting Thread issues right now, once common issues people are encountering are more obvious we can make specific changes to the sync/frontend (or both).

@agners
Copy link
Member

agners commented Jun 28, 2023

Awesome, thanks!

Copy link
Member

@dshokouhi dshokouhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, nice reorganization of the settings menu!

@JBassett JBassett merged commit 1ed0f6a into home-assistant:master Jun 30, 2023
3 checks passed
@jpelgrom jpelgrom deleted the settings-developer-thread branch June 30, 2023 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add an option to manually synchronize Thread credentials
4 participants