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

Adding NVM information #24474

Closed
wants to merge 1 commit into from
Closed

Conversation

raidboy
Copy link

@raidboy raidboy commented Oct 9, 2022

Adding proposed text to document new NVM backup/restore and migration of Z-Wave controller. Community forum articles have varying information, for example the wrong information that one needs to manually run conversion. So it would be good for the official documentation to start documenting the correct steps. I verified the steps migrating from ZST10-700 to ZST10(-500)

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Adding proposed text to document new NVM backup/restore and migration of Z-Wave controller. Community forum articles have varying information, for example the wrong information that one needs to manually run conversion. So it would be good for the official documentation to start documenting the correct steps. I verified the steps migrating from ZST10-700 to ZST10(-500)
@raidboy raidboy requested a review from a team as a code owner October 9, 2022 16:29
@homeassistant homeassistant added current This PR goes into the current branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Oct 9, 2022

For more information, see [Supported Z-Wave dongles](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules)

#### Z-Wave controller NVM

Z-Wave supports backup and restore of Z-Wave controller "Non Volatile Memory" (NVM) via "Control Panel" -> "Advanced Actions". Backup will save an NVM file into "Store" -> "backups" -> "nvm", where it will automatically be saved into system backups and can also be downloaded. Restore will ask the user to restore a file from the local machine.
Copy link
Member

Choose a reason for hiding this comment

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

Looks like you're describing functionality of Z-Wave JS UI. The integration doesn't yet support any NVM features, so we shouldn't document that here yet.

@frenck
Copy link
Member

frenck commented Oct 10, 2022

Thanks for being willing to contribute @raidboy, but Martin is right, this is not functionality in Home Assistant. Most people (as we recommend) don't use Z-Wave JS UI by the Core add-on.
This documentation will be highly confusing for those users.

Therefore, going to friendly decline this PR.

../Frenck

@frenck frenck closed this Oct 10, 2022
@homeassistant homeassistant removed the Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! label Oct 10, 2022
@raidboy
Copy link
Author

raidboy commented Oct 10, 2022

@frenck i am happy to find a place and propose this text to the z-wave js ui documentation instead, but i am confused about your statement of recommending to not using "z-wave js UI by the core add-on". Could you please explain.

Aka: i have HAOS running on RPI4, and in the web UI, on the left, there is "Z-Wave JS". When i click on that, i think the HA web server connects to the "Z-Wave JS UI" which i then see on the right. And that is where all the NVM functionality is.

a) is that understanding correct ?
b) what of that is not recommended ?

I get that user who do not use HAOS may not have this integrating link on the web, but to perform any of the advanced functions of Z-Wave JS that are not mapped via API into HA directly, they would still need to use that Z-Wave JS UI directly, right ?

@frenck
Copy link
Member

frenck commented Oct 10, 2022

Aka: i have HAOS running on RPI4, and in the web UI, on the left, there is "Z-Wave JS". When i click on that, i think the HA web server connects to the "Z-Wave JS UI" which i then see on the right. And that is where all the NVM functionality is.

That is a third-party add-on from the community add-on store. That is not the add-on that the Home Assistant Project recommends. The recommended add-on is provided by the Core add-on repository and automatically installed and set up when setting up the Z-Wave JS integration.

@raidboy
Copy link
Author

raidboy commented Oct 10, 2022

@frenck Still confused:

I remember how ZWave JS was not the official integration last year when i installed it, and all the documentation was very explicit to mention that. But not, it seems that the previous "official" zwave integration was demoted to legacy, and Z-Wave JS is the current official, reommended integration:

https://www.home-assistant.io/integrations/zwave_js/

This integration allows you to control a Z-Wave network via the Z-Wave JS driver. This is our recommended Z-Wave integration for Home Assistant. If you’re migrating from the legacy zwave, see our migration instructions.

In fact, it seems to be the only available integration in current HAOS, its the only z-wave integration i see in the list.

Back in 2021, in HAOS, i could see two lists of integrations, official ones and community. I can not see this distinction anymore.

@frenck
Copy link
Member

frenck commented Oct 10, 2022

I remember how ZWave JS was not the official integration last year when i installed it

It always has been, as a matter of fact, the community version of the add-on was created after the core version.

In any case, this PR described functionality not part of Home Assistant and declined for that reason right now.

@raidboy
Copy link
Author

raidboy commented Oct 10, 2022

Just to be able tto compare: How would i install the "core version" vs. the "community version" ? And if there are two different versions, why is that not mentioned at all in the official home assistant documentation ? Sorry, i am still confused, because i do not see two versions. And the official home assistnt documentation seems to be referring to the version which AFAIK always has that Z-Wave JS UI. I may be wrong, but i would like to understand.

@frenck
Copy link
Member

frenck commented Oct 10, 2022

And if there are two different versions, why is that not mentioned at all in the official home assistant documentation ?

It is mentioned. Many are even put into the FAQ the answer your questions as well: https://www.home-assistant.io/integrations/zwave_js#frequently-asked-questions

@github-actions github-actions bot locked and limited conversation to collaborators Oct 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants