Skip to content

Commit

Permalink
docs: rework the docs on HA Zwave-js integration to be more explicit (#…
Browse files Browse the repository at this point in the history
…2739)

* Rework the docs on HA Zwave-js integration to be more explicit

I had some troubles configuring the zwave-js-ui addon in HA, as I was consistently confused by the documentation which led me in circles. I was focusing on this doc though, so I believe that by making this more explicit, future users can be helped. Through slack, I also found that the "actual" docs are over on HA - where I believed that zwave-js(-ui) wasn't so well included in those docs.. The HA docs are better for actual setup, so I've made sure the step-by-step ends over there.

* Update homeassistant-official.md

* Create homeassistant-official.md

* Apply suggestions from code review

Co-authored-by: kpine <keith.pine@gmail.com>

* Update homeassistant-official.md

Remove MQTT steps, link to docs. Apply more suggestions.

* Update docs/homeassistant/homeassistant-official.md

Co-authored-by: Daniel Lando <daniel.sorridi@gmail.com>

* Update homeassistant-official.md

Co-authored-by: kpine <keith.pine@gmail.com>
Co-authored-by: Daniel Lando <daniel.sorridi@gmail.com>
  • Loading branch information
3 people committed Oct 19, 2022
1 parent 30d0208 commit 605a279
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions docs/homeassistant/homeassistant-official.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
# Home Assistant Using the Official Integration

To integrate your Z-Wave components you can use either the official Home Assistant [Z-Wave JS integration](https://www.home-assistant.io/integrations/zwave_js) and/or MQTT discovery.
To integrate your Z-Wave components you can use either the official Home Assistant [Z-Wave integration](https://www.home-assistant.io/integrations/zwave_js) or MQTT discovery. To read more about the MQTT discovery, see [these docs](/usage/setup?id=home-assistant-using-mqtt-discovery).

## Z-Wave JS server
> [!NOTE]
> Home assistant Z-Wave Integration is the recommended choice as MQTT discovery is much more limited and less maintained.
The Z-Wave JS server is the official way to integrate your Z-Wave devices with Home Assistant. In order to use it go to Settings, [Home Assistant](/usage/setup?id=home-assistant) and enable the flag **WS Server**. Using this method, the official [Z-Wave JS integration](https://www.home-assistant.io/integrations/zwave_js) will automatically create entities in Home Assistant.
## Z-Wave integration

If you do not need the MQTT features, you can [Disable MQTT Gateway](/usage/setup?id=disable-gateway) and use Z-Wave JS UI as an additional user interface to control your Z-Wave network.
Home Assistant has an integration for Z-Wave which is based on Z-Wave JS. You can read more about this at the [Z-Wave integration](https://www.home-assistant.io/integrations/zwave_js) docs.

## Assistance with the Official Integration
To enable the integration:

1. Open the Z-Wave JS UI Settings page
2. Enable the "WS Server" setting in the [Home Assistant](/usage/setup?id=home-assistant) panel
3. If you do not need the MQTT features, you can [Disable MQTT Gateway](/usage/setup?id=disable-gateway) and use Z-Wave JS UI as an additional user interface to control your Z-Wave network.
4. Configure the Z-Wave integration in Home Assistant by following [the official docs](https://www.home-assistant.io/integrations/zwave_js)

Once this has been configured, entities should automatically be created in HA.

### Assistance with the Official Integration

Should you need support with the official Home Assistant Integration, please consult that project's [documentation](https://www.home-assistant.io/integrations/zwave_js/).

Expand Down

0 comments on commit 605a279

Please sign in to comment.