From 4470997627f07af005e258f5570e5169fa852b74 Mon Sep 17 00:00:00 2001 From: Anders Evenrud Date: Thu, 11 Apr 2024 00:11:31 +0200 Subject: [PATCH] docs(help): update instructions --- HELP.md | 63 +++++++++++++++++++++++++++------------------------------ 1 file changed, 30 insertions(+), 33 deletions(-) diff --git a/HELP.md b/HELP.md index 0c2737f..cfedc36 100644 --- a/HELP.md +++ b/HELP.md @@ -1,32 +1,5 @@ # Help -## How do I use my stateless switches ? - -You should be able to use the events `nexa_bridge_x_custom_event` for automation -where the `type` field contains the event from the device. - -## Logs - -The first thing you should do is to check the logs from Home Assistant. - -> This can be viewed from `Settings -> System -> Logs -> LOAD FULL LOGS`. - -For more verbose information from this integration, add the following -to your `configuration.yaml` file: - -```yaml -logger: - logs: - custom_components.nexa_bridge_x: debug -``` - -## Device Compatibility - -See [the device issue](https://github.com/andersevenrud/ha-nexa-bridge-x/issues/6) -for information. - -## Bridge Compatibility - This project was developed using a bridge with firmware version `2.4.1`. Assuming Nexa uses appropriate versioning, this integration *should* be compatible with any @@ -40,24 +13,48 @@ Ensure that you're connecting to the correct IP and with the correct credentials > The factory login is `nexa` / `nexa`. -## I can't see my device +## I don't see any sensor values + +**Ensure that your bridge Firmware is up to date**. Some devices seem to ship with legacy +firmware. If you have registered a new device in the App/Web UI you have to reload the integration first. This is done from the integration settings and the hamburger menu on the card shown on the page. If it still does not show up, see [connection issues](#connection-issues); -## Connection issues +Note that the Nexa Bridge in some cases does not expose all of your sensor values. It is not +a regular z-wave interface, but a custom API. There is an issue that tracks +[tested devices](https://github.com/andersevenrud/ha-nexa-bridge-x/issues/6). + +## How do I use my stateless switches ? + +You should be able to use the events `nexa_bridge_x_custom_event` for automation +where the `type` field contains the event from the device. + +## I'm still having issues. Help! -If you have general issues with connectivity (or crashes related) to the bridge or devices, -create a [new issue on github](https://github.com/andersevenrud/ha-nexa-bridge-x/issues/new) -with a description of the problem and copies of any errors from HA, and preferrably data +Create a [new issue on github](https://github.com/andersevenrud/ha-nexa-bridge-x/issues/new) +with a description of the problem and copies of any errors from HA logs, and preferrably data dumps from your bridge. Providing data dumps can be done with utilities like [Postman](https://www.postman.com/downloads/). The most critical data comes from `http:///api/info` and `http:///api/nodes` and can be accessed using `nexa` as both username -and password. +and password with Digest Authentication enabled. **Some of this data can contain personal information (like location in the "info"), so make sure to censor this before attaching to the issue.** + +### Enabling debug logs + +This can be viewed from `Settings -> System -> Logs -> LOAD FULL LOGS`. + +For more verbose information from this integration, add the following +to your `configuration.yaml` file: + +```yaml +logger: + logs: + custom_components.nexa_bridge_x: debug +```