Community help wanted to whitelist all compatible Zigbee and Z-Wave dongles/adapters for automatic USB Discovery in Home Assistant

[Luke1 (Luke D)]

Hello, I was just wondering if anyone has experienced this issue before, Is set it up originally and it was all working correctly. Then I tried installing ZIgbee2MQTT and it failed, I have deleted Zigbee2MQTT and tried going back to ZHA but it keeps failing, I get the error Failed to set up check the logs

Logger: homeassistant.config_entries
Source: components/zha/core/gateway.py:152
First occurred: 14:14:25 (1 occurrences)
Last logged: 14:14:25

Error setting up entry /dev/serial/by-id/usb-Silicon_Labs_CP2102N_USB_to_UART_Bridge_Controller_Serial Number shows Up-if00-port0 for zha
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/config_entries.py", line 304, in async_setup
    result = await component.async_setup_entry(hass, self)  # type: ignore
  File "/usr/src/homeassistant/homeassistant/components/zha/__init__.py", line 102, in async_setup_entry
    await zha_gateway.async_initialize()
  File "/usr/src/homeassistant/homeassistant/components/zha/core/gateway.py", line 152, in async_initialize
    self.application_controller = await app_controller_cls.new(
  File "/usr/local/lib/python3.9/site-packages/zigpy/application.py", line 69, in new
    await app.startup(auto_form)
  File "/usr/local/lib/python3.9/site-packages/zigpy_znp/zigbee/application.py", line 196, in startup
    return await self._startup(
  File "/usr/local/lib/python3.9/site-packages/zigpy_znp/zigbee/application.py", line 255, in _startup
    await self._write_stack_settings(reset_if_changed=True)
  File "/usr/local/lib/python3.9/site-packages/zigpy_znp/zigbee/application.py", line 1129, in _write_stack_settings
    current_value = await self._znp.nvram.osal_read(
  File "/usr/local/lib/python3.9/site-packages/zigpy_znp/nvram.py", line 173, in osal_read
    raise KeyError(f"NV item does not exist: {nv_id!r}")
KeyError: 'NV item does not exist: <OsalNvIds.CONCENTRATOR_ENABLE: 50>'

Logger: zigpy.application
Source: /usr/local/lib/python3.9/site-packages/zigpy/application.py:73
First occurred: 14:14:25 (1 occurrences)
Last logged: 14:14:25

Couldn't start application

Logger: zigpy_xbee.api
Source: /usr/local/lib/python3.9/site-packages/zigpy_xbee/api.py:390
First occurred: 14:13:28 (1 occurrences)
Last logged: 14:13:28

at: No response to AP command

Logger: zigpy_zigate.api
Source: /usr/local/lib/python3.9/site-packages/zigpy_zigate/api.py:140
First occurred: 14:13:26 (1 occurrences)
Last logged: 14:13:26

Retry command 0x0002

I have tried to uninstall it Remove the Zigbee database file, Go To a backup of home assistant before I installed Zigbee2Mqtt.

When I reinstall ZHA it finds the serial device path to the USB without any Issues,

Created configuration for CP2102N USB to UART Bridge Controller, s/n: Serial Number shows up - Silicon Labs.

But I get this error

Any Ideas What I am doing wrong?

[francisp (Francis)]

You are sure Zigbee2MQTT is not running anymore ?

[Luke1 (Luke D)]

Yes It’s definitely not running or installed

[Hedda]

@Luke1 off-topic for this subject so please suggest that you create a brand new thread for that instead.

[Hedda]

@Hedda

FYI, users who got one of the first batch ITead Sonoff Zigbee 3.0 USB Dongle Plus (which has Silabs CP2102 USB-to-UART bridge with programable EEPROM) report that ITead has, unfortunately, forgot/missed or chosen not to configure their own custom “Product Description” string to it.

That means that those cannot use USB discovery even though their hardware supports it, which is a real bummer. IMHO potential buyers should really write to them and ask them to configure this on them.

FYI, got a reply from ITead that they will change default “CP2102 USB to UART Bridge Controller” text in the Product Description String value field to “Sonoff Zigbee 3.0 USB Dongle Plus” in their next batch.

They already tested that USB discovery works in Home Assistant on Linux, but the change will require them to generate and provide a custom device driver for Microsoft Windows-based operating systems.

Why it would require them to generate and provide a custom device driver I do not know as changing only changing the “Product Description” and leaving the original VID and PID should not require that.

[javicalle]

BitronVideo AV2010/10 ZHA stick to be added here:

• https://github.com/home-assistant/core/pull/58337

[Hedda]

ZigStar Stick USB discovery to be added here (PR patch by @mercenaruss = the maker of ZigStar):

• HA core pull request → https://github.com/home-assistant/core/pull/59559
  • ZHA docs PR → Update zha.markdown with ZigStar USB Discovery by Hedda · Pull Request #20320 · home-assistant/home-assistant.io · GitHub

ZigStar is by the way an open source hardware (USB dongle is based on CC2652P + CH340B chip):

https://community.home-assistant.io/t/zigstar-zigbee-coordinators-and-routers/338586

https://zig-star.com/projects/zigbee-stick-v4/

https://github.com/mercenaruss/zigbee-stick-v4

https://www.tindie.com/stores/zigstar/

[Hedda]

@Hedda

@Hedda

FYI, users who got one of the first batch ITead Sonoff Zigbee 3.0 USB Dongle Plus (which has Silabs CP2102 USB-to-UART bridge with programable EEPROM) report that ITead has, unfortunately, forgot/missed or chosen not to configure their own custom “Product Description” string to it.

That means that those cannot use USB discovery even though their hardware supports it, which is a real bummer. IMHO potential buyers should really write to them and ask them to configure this on them.

FYI, got a reply from ITead that they will change default “CP2102 USB to UART Bridge Controller” text in the Product Description String value field to “Sonoff Zigbee 3.0 USB Dongle Plus” in their next batch.

They already tested that USB discovery works in Home Assistant on Linux, but the change will require them to generate and provide a custom device driver for Microsoft Windows-based operating systems.

Why it would require them to generate and provide a custom device driver I do not know as changing only changing the “Product Description” and leaving the original VID and PID should not require that.

@tteck reported in another thread that the very latest batch of Sonoff Zigbee 3.0 USB Dongle Plus that has shipped now looks to have a unique product description value written to CP2102N EEPROM.

The question that remains to answer is which exact product description that ITead chose to go with.

Perhaps people with new batch can verify product description and test changes from this pull request:

https://github.com/home-assistant/core/pull/58166

That uses wildcards so think it will work as long as product description contains “sonoff” somewhere(?).

[Hedda]

@Hedda

@tteck reported in another thread that the very latest batch of Sonoff Zigbee 3.0 USB Dongle Plus that has shipped now looks to have a unique product description value written to CP2102N EEPROM.

The question that remains to answer is which exact product description that ITead chose to go with.

Perhaps people with new batch can verify product description and test changes from this pull request:

[WIP] Prepare for USB discovery of Sonoff Zigbee 3.0 USB Dongle Plus by Hedda · Pull Request #58166 · home-assistant/core · GitHub

That uses wildcards so think it will work as long as product description contains “sonoff” somewhere(?).

@tteck posted serial path old and new batch shipped from ITead with updated Sonoff Zigbee 3.0 USB Dongle Plus product description in https://community.home-assistant.io/t/sonoff-zigbee-3-0-usb-dongle-plus-by-itead-is-based-on-texas-instruments-cc2652p-can-be-pre-ordered-for-10-99/340705/174

Old ID

/dev/serial/by-id/usb-Silicon_Labs_CP2102N_USB_to_UART_Bridge_Controller_a4766cbfb593eb11b7611b4f3d98b6d1-if00-port0

New ID

/dev/serial/by-id/usb-ITead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_201e5if00-port0

Serial path adds “usb-” + vendor as prefix and some ID and port-number as suffix + added underscores.

So assume new product description is “Sonoff Zigbee 3.0 USB Dongle Plus” (without underscores).

Again, can someone with new batch HW test PR? → https://github.com/home-assistant/core/pull/58166

I do not own a dongle from the new batch with the new product description so can not test it myself.

[Hedda]

FYI, ITead now posted a script/program that should let users themselves update the product description on already shipped dongles to supposedly match description already written to latest batch of dongles:

https://www.facebook.com/SONOFF.official/posts/2927251720919807

Tested it myself on a Windows 10 computer and it did not work for me (it closed without any messages).

Sadly ITead did not just release a script tool based on this open-source cp210x-program by VCTLabs:

https://github.com/VCTLabs/cp210x-program

Again, the point of having a unique custom product description is to allow USB auto-discovery in ZHA:

https://community.home-assistant.io/t/community-help-wanted-to-whitelist-all-compatible-zigbee-and-z-wave-usb-adapters-for-automatic-discovery-in-home-assistant-os/344412

Community help wanted to whitelist all compatible Zigbee and Z-Wave dongles/adapters for automatic USB Discovery in Home Assistant

Also have Zigbee or Z-Wave USB dongles that are not whitelisted for automatic USB discovery in HA? Please help this whole community and companies making USB adapters to get their USB devices on the whitelist for each integration in order to be automatically discovered and correctly identified. https://www.home-assistant.io/blog/2021/09/01/release-20219/#usb-discovery Back-story: Home Assistant developer and Nabu Casa employee Nick Koston (a.k.a. bdraco) recently added a new user-friendly feat…

[Hedda]

@Hedda

Again, can someone with new batch HW test PR? → [WIP] Prepare for USB discovery of Sonoff Zigbee 3.0 USB Dongle Plus by Hedda · Pull Request #58166 · home-assistant/core · GitHub

I do not own a dongle from the new batch with the new product description so can not test it myself.

FYI, OpenMyDog submitted a new PR for ZHA discovery of Sonoff Zigbee 3.0 USB Dongle Plus:

https://github.com/home-assistant/core/pull/62171

Add USB discover for Sonoff zigbee dongle plus

[Hedda]

@Hedda

FYI, OpenMyDog submitted a new PR for ZHA discovery of Sonoff Zigbee 3.0 USB Dongle Plus:

https://github.com/home-assistant/core/pull/62171

FYI, Home Assistant 2022.2 release notes now menation USB discover of Sonoff Zigbee Dongle Plus:

https://www.home-assistant.io/blog/2022/02/02/release-20222/#all-changes

• “Add USB discover for Sonoff zigbee dongle plus (@OpenMyDog - #62171) (zha docs)”

Again, this only applies to newer batches of shipped dongles the initial batches missing ID in CP2102N, as if your dongle does not have this unique description then it will be discovered as dongle for Z-Wave.

@Hedda

FYI, ITead now posted a script/program that should let users themselves update the product description on already shipped dongles to supposedly match description already written to latest batch of dongles:

https://www.facebook.com/SONOFF.official/posts/2927251720919807

Tested it myself on a Windows 10 computer and it did not work for me (it closed without any messages).

Sadly ITead did not just release a script tool based on this open-source cp210x-program by VCTLabs:

https://github.com/VCTLabs/cp210x-program

Again, the point of having a unique custom product description is to allow USB auto-discovery in ZHA:

Community help wanted to whitelist all compatible Zigbee and Z-Wave dongles/adapters for automatic USB Discovery in Home Assistant

[Hedda]

FYI, looks like Home Assistant will soon support automatic USB discovery for the new ITead’s “Sonoff Zigbee 3.0 USB Dongle Plus V2” model “ZBDongle-E” based on Silicon Labs EFR32MG21 if merge:

  {
      "vid": "1A86",
      "pid": "55D4",
      "description": "*sonoff*plus*",
      "known_devices": ["sonoff zigbee dongle plus v2"]
    },

It uses a WCH CH9102F (CH9102/CH340 device drivers) for USB-to-UART chip which has VID (Vendor ID) "1A86 "and PID (Product ID) 55D4 as well as the new USB product description identifier “sonoff zigbee dongle plus v2” on this variant.

Add the USB discovery for the Sonoff ZigBee dongle plus V2

Added the description of Sonoff ZBDongle-E to the HA auto-discovery list

see product discussion:

ITead’s “Sonoff Zigbee 3.0 USB Dongle Plus V2” (model "ZBDongle-E") based on Silicon Labs EFR32MG21 +20dBm radio SoC/MCU

FYI, ITead just released a new “ZBDongle-E” adapter as an improved version of their old/previous barebone Silabs EFR32MG21 based Zigbee 3.0 USB adapter from ITead and this new variant is to be sold side-by-side as an alternative to ITead’s TI CC2652P based “Sonoff Zigbee 3.0 USB Dongle Plus” (which is now renamed to “ZBDongle-P”), meaning they will continuously sell both variants and while both type of radio SoC chips practically have the same specifications on paper, they use different Zigbee s…

[Hedda]

FYI, it is still a known problem that USB discovery entries for Z-Wave JS are too generic, with the main root cause of that problem being most manufacturers of Z-Wave Controller, unfortunately, have the bad habit of not writing their own custom “Description” to USB-to-Serial converter/bridge chip EEPROM.

See issue → https://github.com/home-assistant/core/issues/55586

USB discovery entries for Z-Wave JS are too generic

[freshcoast (Z-Wave AI Bot)]

The Z-Wave discovery of these USB devices was removed months ago, in release 2022.9. It would seem the issue has been addressed, or do you observe otherwise?

Remove Z-Wave JS trigger uart USB id

[Hedda]

FYI, Zvidar released both a black-colored Z-Wave 800 series USB dongle called “Zvidar Z-GW-V20” as well as a white-coloured Silicon Labs EFR32MG21 based Zigbee dongle called “Zvidar Z-DG-Z01”:

http://www.zvidar.com/pro/20.html

https://zigbee.blakadder.com/Zvidar_Z-DG-Z01.html

https://www.domadoo.fr/en/interface-domotique/6500-zvidar-zigbee-usb-dongle-efr32mg21-chipset-compatible-thread-and-matter.html

https://shop.smarthome-europe.com/en/interface-domotique/5486-zvidar-zigbee-usb-dongle-efr32mg21-chipset-compatible-thread-and-matter.html

https://www.tronika.no/en/smarthome/zigbee-products/zigbee-interfaces/interface-z-dg-z01.html

Apparently, the “Zvidar Z-DG-Z01” USB Zigbee adapter is USB discovered by VID/PID "1a86:55d4 " and product identifier "QinHeng Electronics USB Single Serial " or with serial by-id as "usb11a86_USB_Single_Serial_54F7005713-if00 " (where “54F7005713” is the serial number), which I believe is just a default for WCH CH340 Serial-to-USB bridge chip and not a unique product identifier, or is it?

Again, someone should try to inform companies like Zvidar that they really need to use Serial-to-USB bridge chip with writable EEPROM and write a unique USB product identifier to it for USB discovery!

Check out this blog:

https://www.domo-blog.fr/zvidar-zigbee-matter-thread-dongle-domotique-jeedom-home-assistant/

[darkxst (Tim L)]

@Hedda

Again, someone should try to inform companies like Zvidar that they really need to use Serial-to-USB bridge chip with writable EEPROM and write a unique USB product identifier to it for USB discovery!

First, Zvidar are focused on the ODM market, this is primarily meant to be a whitelabel product.

Most variants of the CH340 dont include an EEPROM, only the CH340B has one AFAIK.

[Hedda]

Anyone got the Aeotec Zi-Stick (model “ZGA008”) and if so can check its USB product description?

If anyone own one would appreciate it if let us know USB product description to be used as identifier:

https://community.home-assistant.io/t/aeotec-zi-stick-model-zga008-zigbee-coordinator-usb-dongle-based-on-silicon-labs-efr32mg21-20dbm-radio-soc-mcu/624564

Aeotec Zi-Stick (model “ZGA008”) Zigbee Coordinator USB dongle based on Silicon Labs EFR32MG21 +20dBm radio SoC/MCU

FYI, Aeotec have released Aeotec Zi-Stick (model “ZGA008”) Zigbee Coordinator USB radio adapter based on the same popular Silicon Labs EFR32MG21 SoC/MCU that is also used in the Home Assistant SkyConnect (USB stick), ITead’s “Sonoff Zigbee 3.0 USB Dongle Plus V2” (model “ZBDongle-E”) , SMLIGHT SLZB-07, as well as in the easyiot ZB-GW04 Zigbee dongle. Zi-Stick (Zigbee) – Aeotec Aeotec Zi-Stick (Zigbee) – Aeotec Store They specifically mention compatibility with various Zigbee gateway solut…

[Hedda]

FYI, there is a draft pull release for ConBee III USB product description for automatic USB discovery under Home Assistant OS (e.i. ZHA whitelisting for automatic USB discovery of ConBee 3 adapter):

Add CB3 descriptor to ZHA manifest

ConBee III (ConBee 3) from Dresden-Elektronik based on Silicon Labs EFR32MG21 +20dBm radio SoC/MCU

FYI, ConBee III (ConBee 3) from Dresden-Elektronik been officially released in early November 2023. https://phoscon.de/en/conbee3 [image] ConBee3 runs an updated variant of Dresden-Elektronik’s custom deconz Zigbee firmware with their own serial protocol interface (which does not look to have updated documentation yet), as such is primarily meant to work with Dresden-Elektronik’s own deCONZ/Phoscon Zigbee Gateway host application (and the matching deCONZ integration) as a replacement for the…

[Hedda]

Tip to radio USB adapter manufacturers using CP2102 or CP2102N CP210x USB-to-serial bridge chip is to check out this new CP2102N programmer add-on for Home Assistant that allow end-users to program the manufacturer and product strings to the EEPROM CP210x USB-to-serial converter chip if missed doing so for an already shipped batch of adapters or for want to change a string (or both):

https://github.com/home-assistant/addons-development/tree/master/skyconnect_cp2102n_programmer