Z-Wave JS UI Driver: Failed to open the serial port Cannot lock port (ZW0100)

freshcoast · January 23, 2023, 3:34pm

You can’t run both add-ons at the same time. The integration will try to keep the official add-on running at all times. Either uninstall the integration and the add-ons, and start over with ZUI only, or follow the docs to switch:

SDMark · January 23, 2023, 9:33pm

I’m a little fuzzy on terms like integration vs add-ons. I’ve uninstalled the Z-Wave JS add-on. Not sure how or where to uninstall the integration. I keep going from screen to screen trying to find stuff and it’s very confusing as to where to disable things, etc. Right now, I’m only running the Z-Wave JS UI and it’s still telling me the port is locked.

I tried following the instructions to switch from JS to JS UI, unchecked using the Supervisor, but when I go to add the Z-Wave JS integration back in, it stops at the point where it’s asking for to connect to the URL ws://localhost:3000. It says can’t connect. I’ve also tried 0.0.0.0, still no dice.

freshcoast · January 23, 2023, 10:35pm

Maybe the glossary will help:

In this case, the add-ons are communicating with the Z-Wave controller and hosting a server, and the Z-Wave integration talks to a server running in the add-on, instead of directly to the controller.

I’ve uninstalled the Z-Wave JS add-on. Not sure how or where to uninstall the integration.

Did you not install the integration in the first place to get to this point? Integrations are added/removed/configured in Settings → Devices & Services. Presumably, you installed the integration and said that you wanted to use the Supervisor add-on, and if you did that, HA will not stopping re-installing it, even if you uninstall it. To break this cycle requires either uninstalling the integration, or re-configuring it.

Those are both the wrong URLs for the ZUI add-on. Be sure to read the accompanying documentation when you install an add-on, which is visible from the add-on page itself, and for ZUI also here: https://github.com/hassio-addons/addon-zwave-js-ui/blob/cbe714b48d81d09702bfbb79317264460bb5e38b/zwave-js-ui/DOCS.md#setting-up-the-home-assistant-z-wave-js-integration

In the next dialog it will ask for the server. Enter: ws://a0d7b954-zwavejs2mqtt:3000

FYI, this configuration is also mentioned in the integration docs: https://www.home-assistant.io/integrations/zwave_js/#installing-and-configuring-the-z-wave-integration-in-home-assistant (emphasis mine)

If you’re running full Home Assistant with supervisor, you will be presented with a dialog that asks if you want to use the Z-Wave JS Supervisor add-on. You must uncheck this box if you are running the Z-Wave JS server in any manner other than the official Z-Wave JS add-on, including using Z-Wave JS UI add-on.

If you’re not running the supervisor or you’ve unchecked the above-mentioned box, you will be asked to enter a websocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (Docker) IP/hostname here. For example for the Z-Wave JS UI add-on this is ws://a0d7b954-zwavejs2mqtt:3000.

SDMark · January 26, 2023, 1:05am

I was positive. I had a GEN 5+, but just to be sure I used a USB hub. And voilà! It now detected the correct stick, and added it to my system. There are still some issues, but I will create a new post for them as I have time.

Thank you very much for your assistance. It’s greatly appreciated!

Mark

MarkWalsh · February 19, 2023, 9:02pm

I am in the same situation. I installed the Z-Wave JS add-on, and set up my network and devices, and now would like to use the Z-Wave JS UI now that I have found out about it.

I have added the same keys used in the JS integration into the JS UI integration, set the port and the server is set to ws://core-zwave-js/

Can I just stop the one add-on and start the UI add-on; will the devices still be connected or will I need to go through the process of adding them again?

MarkWalsh · February 19, 2023, 11:20pm

I stopped the Z-Wave JS add-on, and it looks like the JS UI add on is working properly.

Edit: I was mistaken, devices were showing up on the UI, but all my dashboards and automations didn’t. I disabled the JS UI add on for now, and everything is back to where it was.

I’ll need to figure out more on how to properly set this up when I have more time. Any suggestions welcome.

freshcoast · February 20, 2023, 1:20am

I posted the instructions to switch above. Here they are again.

MarkWalsh · February 20, 2023, 2:02am

Thanks.

To clarify, I disable the current JS integration, and then after configuring the JS UI add-on, I don’t enable it, I have to go through the “Add Integration” process?

I had just re-enabled it before, I’m guessing that was the issue.

freshcoast · February 20, 2023, 2:47am

You should follow all of the steps that are listed, otherwise it won’t work. Especially step 4, which re-configures the server to connect to.

MarkWalsh · February 23, 2023, 2:06pm

Ugh, still no luck. Not sure what I did wrong (I’m sure I had the correct address, that’s the only thing I can assume was the issue), but I did find your other writeup on this, I’ll try that again this weekend.

Lonestar10 · May 25, 2023, 10:50pm

I love Home Asssiant and I support the team. But why is Zwave so fragnmented? Why can’t we have one native Zwave inegration that just works? Screw all these confusing add-ons.
Sorry to vent, but my entire zwave network is offline after the Zwave JS UI update 1.13. Backups won’t fix this, so I’m haing to rebuild the Zwave network…and I got this port error.

freshcoast · May 26, 2023, 12:37am

This thread has the instructions for fixing the “lock port” error. Did you try them?

Lonestar10 · May 26, 2023, 1:57am

I did get it resolved. Your post in partitcular was helpful. Thank you.

freshcoast · May 26, 2023, 2:45am

Glad to hear that. If you have such problems in the future, take a look at the HA logs and add-on logs first (if you didn’t first) before going the nuclear route. There were a couple of issues, now fixed, revealed by driver updates. No idea if that happened in this case, but the logs would tell us.

drzwave · September 12, 2023, 6:11pm

In Step 4, What is: Enter the correct address for the community add-on in the URL field in the next step.?
What is the “correct address”?
Can you give me an example?

By default when adding the Z-Wave JS UI Integration (and unchecking the Z-Wave JS Supervisor add-on) the popup has: ws://localhost:3000
Is that the “correct address”? apparently not as I get a Failed to Connect message.

I have to agree this is much more difficult than I had hoped and I’ve spent a few hours trying to get this started up and I keep running in circles.

I suggest:

after clicking on the Add Integration and searching for Z-Wave, then selecting Z-Wave
in addition to the checkbox for Use the Z-Wave JS Supervisor add-on
a radio button allows the Z-Wave JS UI add-on to be installed instead.
And have a note or when hovering over each one it says the UI version is for advanced users.

drzwave · September 12, 2023, 7:26pm

After more running in circles, I tried: ws://a0d7b954-zwavejs2mqtt:3000
which worked. How can we make this the default instead of localhost?

freshcoast · September 12, 2023, 8:22pm

The URL for the community add-on is documented many places, including multiple times in this very thread, just scroll up a bit.

As a reminder to anyone else stumbling into this thread, when you install an add-on, but sure to read the add-on docs first. This setting is mentioned clearly in the Z-Wave JS UI add-on docs.

The same instructions are in the Z-Wave integration docs.

Many people do not use add-ons, and others use the official add-on, so that value as a default is not correct either. I can only speak for myself, but I don’t think core integrations should hard-code things related to community add-ons. The effort would be better spent on HA being able to auto-discover the add-on and presenting it as a choice, instead of requiring manual entry.

The default URL for the configuration dialog is set here:

github.com

home-assistant/core/blob/1b40a56e2b9ae204b400d100a03757a31cfbefae/homeassistant/components/zwave_js/config_flow.py#L59


      
              CONF_S2_ACCESS_CONTROL_KEY,
              CONF_S2_AUTHENTICATED_KEY,
              CONF_S2_UNAUTHENTICATED_KEY,
              CONF_USB_PATH,
              CONF_USE_ADDON,
              DOMAIN,
          )
          
          _LOGGER = logging.getLogger(__name__)
          
          DEFAULT_URL = "ws://localhost:3000"
          TITLE = "Z-Wave JS"
          
          ADDON_SETUP_TIMEOUT = 5
          ADDON_SETUP_TIMEOUT_ROUNDS = 40
          CONF_EMULATE_HARDWARE = "emulate_hardware"
          CONF_LOG_LEVEL = "log_level"
          SERVER_VERSION_TIMEOUT = 10
          
          ADDON_LOG_LEVELS = {
              "error": "Error",

Anyone can submit a PR to the project. Getting it accepted is another story, so you can try your luck if you like.

Geoff_B · December 12, 2023, 5:29pm

This thread was very helpful, partly because it came up above the official docs in a google search, and partly because it made me reassess my incorrect assumptions about what Z-Wave JS UI is.

While I’m as guilty as anyone when it comes to only skimming official documentation, from reading this thread it’s not only me, and I’m sure the correct answer to this is for me to pay more attention (and that will be my takeaway!).

But mainly what threw me off track originally was the naming; I see one addon called “Z-Wave JS”, which is referred to as a server, and the very top of the installation instructions have you install this by default. I did this.

Then I see references to “Z-Wave JS UI” which looks pretty cool, and I immediately interpret this name (obviously incorrectly) as “the UI addon to Z-Wave JS”. What it really means is “Z-Wave JS With UI”.

Once I got past all that, and followed @freshcoast’s instructions, turns out it is pretty cool, and works well. So kudos to the community devs for producing yet something else amazing.

All that leads me to my actual question; was there a reason this wasn’t just done as a pure UI addon to the existing server, rather than replicating the entire thing?

freshcoast · December 12, 2023, 7:39pm

Z-Wave JS UI is an independent application written by a developer that has no affiliation with Home Assistant. The project has also existed much longer, prior to HA being involved with Z-Wave JS (previously being zwavejs2mqtt and before that zwave2mqtt, those projects focusing on being an MQTT bridge). Many people prefer the UI it provides, and integration with the Z-Wave JS server is there to support HA users. It also interfaces directly with the Z-Wave JS driver, so there’s no need for it to be limited by the websocket API.

If anyone wants to write their own UI using the Z-Wave JS server (websocket server), they would be free to do that. But that’s what HA already is, there’s little reason for an add-on UI.

Geoff_B · December 13, 2023, 2:53pm

Thanks, this helps explain it, especially the history.

Totally why I installed it too, and agree wholeheartedly.

I’m guessing that “integration with” means that it encapsulations the same Z-Wave JS Server that HA uses, is that right?

Do you mind explaining this? In my head it looks like
HA → Z-Wave JS UI addon → (contains Z-Wave JS server → (contains Z-Wave JS driver)), but that’s probably way off

When I originally installed the Z-Wave JS addon, it didn’t have a great UI, and certainly not the UI that the Z-Wave JS UI addon has, unless I missed it? Because this seemed kind of lacking, I looked around and found the same name with “UI” tacked on the end, and mistakenly assumed this was a UI addition. Maybe (probably!) I’m missing your point, though.