Add Z-Wave controller hard reset device action (certification req) #18216

raman325 · 2023-10-14T07:05:13Z

Proposed change

This PR adds a new device action for the controller to hard reset it which is a Z-Wave certification requirement. We want it to be hard to do to avoid accidental resets which is why there are multiple confirmations. There is an issue that we may need to resolve beforehand where the config entry drops and reloads but need opinions on that. Also is it weird that the device info underneath the dialog goes to Device / service not found? CC @MartinHjelmare @marcelveldt @AlCalzone - please review the copy and provide feedback.

Upstream core changes are already merged.

Device action:

First warning:

Second warning:

In progress:

Complete:

Final device info page when you close the dialog:

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes Z-Wave JS: Controller hard reset needs to be exposed zwave-js/certification-backlog#13
Link to core pull requests:
- Add Z-Wave WS command to hard reset controller core#101449
- Update zwave_js/hard_reset_controller WS cmd core#102280
Link to documentation pull request: Add docs for new zwave hard reset action home-assistant.io#29362

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

AlCalzone · 2023-10-14T07:45:53Z

Looks good to me. As for the last error, the factory reset changes the home ID of the controller. I think this is why the device isn't being found anymore.

raman325 · 2023-10-14T13:30:53Z

Yeah that's a good point. I don't think we want the device to be the same so I was more just wondering about the experience. There may be a way to back out of that when you close the dialog, I'm just not sure how at the moment. That does give me an idea though.... 🤔

That may be related to the experience with the config entry where it needs to disconnect and reconnect, but really I just need to enable debug logs so I can see what's going on

raman325 · 2023-10-14T15:03:08Z

I added logic which works when it's not wrapped in the conditional but doesn't work within the conditional (how the code looks now). I feel like there is something obvious I must be missing...

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts

Co-authored-by: Bram Kragten <[email protected]>

bramkragten · 2023-10-16T11:31:18Z

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts

+      })
+    ) {
+      await hardResetController(this.hass, this.entry_id!);
+      this._done = true;


Navigate to the devices page of the config entry here:

navigate(`/config/devices/dashboard?config_entry=${this.entry_id}`)

this works, but the downside is that it takes the user to potentially a new location instead of going back to where they were, which is, in my opinion better. But I am realizing part of the problem is that the history state will include the pop ups. So if I want to do this, I think I need to store the previous page from the history and then navigate to that when done. Does that sound right?

ah I guess you aren't allowed to do that... 🤔

I implemented it with your suggestion for now, but if there's another way that we can truly go back to the previous page, I think that would be the better option

I think the best user experience would be to navigate to the device page of the newly created device, but I'm not sure how the timing is, is the new device available immediately? Maybe hardResetController could return the new device id or something?

OK so I got it working but:

If the user closes the dialog, the redirect doesn't happen. I think this could be solved by changing hardResetController to only return when the new device is available but I will have to do some testing.

I'm guessing the method I am using to track the device is inefficient. Might be solved by the solution for 1

OK so made the updates above. Now the only problem is that when I navigate to the new device page, it says the device doesn't exist until I refresh the page. Not sure if there's something else I can wait for to guarantee the device is available before redirecting?

Looking at the code the page should update when new devices are added... And a refresh should not be needed...

I also see that happening in my tests...

ok so we can remove the refresh and log a bug for this maybe?

Do you have a quick repo for me for this?

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts

codyc1515 · 2023-10-23T05:36:24Z

Is it worth using the word Warning somewhere in a header / title for those fast-clickers among us?

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts

…log-zwave_js-hard-reset-controller.ts

AlCalzone · 2023-11-20T10:55:29Z

It's a bit awkward that the "back" button goes back to the hard reset dialog atm.

Add Z-Wave controller hard reset device action

7c54964

home-assistant bot added cla-signed hacktoberfest labels Oct 14, 2023

raman325 added 2 commits October 14, 2023 09:52

bug fix

1a6ac6d

Add non working history.back

274706c

don't think timeout is needed here

a55021e

raman325 changed the title ~~Add Z-Wave controller hard reset device action~~ Add Z-Wave controller hard reset device action (certification req) Oct 15, 2023

Clarify that this is network specific

d4e48bb

raman325 mentioned this pull request Oct 15, 2023

Add docs for new zwave hard reset action home-assistant/home-assistant.io#29362

Merged

8 tasks

bramkragten reviewed Oct 16, 2023

View reviewed changes

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts Outdated Show resolved Hide resolved

Update dialog-zwave_js-hard-reset-controller.ts

174126a

Co-authored-by: Bram Kragten <[email protected]>

bramkragten reviewed Oct 16, 2023

View reviewed changes

raman325 added 4 commits October 16, 2023 08:15

review

aee12c9

navigate to new device entry

731d936

changes

341cf10

Simplify

ad4f651

raman325 mentioned this pull request Oct 19, 2023

Update zwave_js/hard_reset_controller WS cmd home-assistant/core#102280

Merged

20 tasks

raman325 added 2 commits October 18, 2023 23:23

fix html

beae59e

clean up keys

c4d052b

bramkragten reviewed Oct 19, 2023

View reviewed changes

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts Outdated Show resolved Hide resolved

raman325 force-pushed the hard_reset branch from c2a10fc to c4d052b Compare October 19, 2023 19:52

bramkragten reviewed Oct 23, 2023

View reviewed changes

...els/config/integrations/integration-panels/zwave_js/dialog-zwave_js-hard-reset-controller.ts Show resolved Hide resolved

bramkragten previously approved these changes Oct 23, 2023

View reviewed changes

Update src/panels/config/integrations/integration-panels/zwave_js/dia…

ee97f21

…log-zwave_js-hard-reset-controller.ts

bramkragten dismissed their stale review via ee97f21 October 23, 2023 13:55

bramkragten previously approved these changes Oct 23, 2023

View reviewed changes

Update dialog-zwave_js-hard-reset-controller.ts

edd7486

bramkragten dismissed their stale review via edd7486 October 23, 2023 15:57

bramkragten approved these changes Oct 24, 2023

View reviewed changes

bramkragten merged commit d8d16c4 into home-assistant:dev Oct 24, 2023
12 checks passed

raman325 deleted the hard_reset branch October 24, 2023 23:00

github-actions bot locked and limited conversation to collaborators Nov 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Z-Wave controller hard reset device action (certification req) #18216

Add Z-Wave controller hard reset device action (certification req) #18216

raman325 commented Oct 14, 2023 •

edited

Loading

AlCalzone commented Oct 14, 2023

raman325 commented Oct 14, 2023

raman325 commented Oct 14, 2023

bramkragten Oct 16, 2023

raman325 Oct 16, 2023

raman325 Oct 16, 2023

raman325 Oct 16, 2023

bramkragten Oct 16, 2023

raman325 Oct 18, 2023

raman325 Oct 19, 2023

bramkragten Oct 19, 2023

raman325 Oct 19, 2023

bramkragten Oct 23, 2023

codyc1515 commented Oct 23, 2023

AlCalzone commented Nov 20, 2023

Add Z-Wave controller hard reset device action (certification req) #18216

Add Z-Wave controller hard reset device action (certification req) #18216

Conversation

raman325 commented Oct 14, 2023 • edited Loading

Proposed change

Type of change

Additional information

Checklist

AlCalzone commented Oct 14, 2023

raman325 commented Oct 14, 2023

raman325 commented Oct 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codyc1515 commented Oct 23, 2023

AlCalzone commented Nov 20, 2023

raman325 commented Oct 14, 2023 •

edited

Loading