Zigbee Router: Feedback wanted!

[Nerivec]

Zigbee router firmware are now added for most adapters.
https://github.com/Nerivec/silabs-firmware-builder/releases/tag/v2024.6.2-update3

We need some feedback on the new features, how it performs, issues using it, etc.!

As a reminder, here are some details on it:

The router should automatically try to join a nearby open network every 10 seconds as long as it is not already joined (will continue indefinitely as long as it has power).

Using the reset button in the device's Z2M page, should allow you to enter the bootloader on the device, making flashing "from router firmware" easier (no need to open the casing, short pins, etc.). If USB, ensure you plug your device into the computer you intend to use for flashing BEFORE you press the reset button. Flashers should then be able to detect the launched bootloader and allow immediate flashing. If you press this by accident, a simple unplug/short wait/replug should take your device out of the bootloader. The button is one-way, since the device should disconnect immediately after pressing it, to enter the bootloader.

More advanced use:
When plugged into a computer (or over the network for TCP adapters), you can monitor the activity on the router using a serial/TCP monitor (various terminals can do it, also the extension in VSCode, and Ember ZLI as of 2.9.0). These logs may offer insights into misbehaving devices (e.g. during joins), from the perspective of a router, instead of the usual logs from the coordinator from Z2M.
Note: The logs are in silabs' short-hand, which is not always easy to read, but someone should be able to help decipher, if you ask nicely!. 😉

Devices supporting LED/button integration will have these extra features (currently: Sonoff ZBDongle-E):

• The LED will turn on and off (slowly) to alert of the fact the adapter is running a new scan. Once joined, the LED will stay fixed.
• The button has 4 distinct behaviors:
  1. No network, long press (>5s): reboot into bootloader
  2. No network, short press: toggle network steering (start/stop trying to join)
  3. Joined to a network, long press (>5s): leave network
  4. Joined to a network, short press: toggle source route discovery (start/stop broadcasting MTORRs)

Tip

Toggled statuses from button only remain effective while the adapter is powered on. Power cycling the adapter will bring them back to defaults.

Tip

If the device doesn't appear as it should in Z2M after flashing the router firmware, and it was previously joined to Z2M, trigger a re-interview to force the information to update. Among other updated properties, Firmware build date should now read 2024....

Tip

If you are getting weird errors from your router after flashing (like failed to configure), it may mean some leftovers from previous use (coordinator) are causing troubles (since this information is not erased when flashing). Try clearing the NVM3 on the adapter. You can find the appropriate GBLs to do so here.

Notes on configuration for the external converter:

Example snippet (note the indentation):

advanced:
  log_level: debug
  last_seen: ISO_8601_local
external_converters:
  - silabs-adapter-with-router-firmware-converter.js

• Make sure you use the proper folder to put the converter file in, and proper configuration.yaml to set it up (in HA, it's usually under the zigbee2mqtt folder).
• Make sure the format does not change when you copy/paste in the configuration.yaml (indentation is important, it should be on its own lines, and without spaces at the beginning of external_converters:).

[kraus-wagner]

I tried to flash your router firmware 8.0.2.0 to a sonoff dongle-e several times now. I tried the silabs web flasher from darkxst and secureCRT. No errors, everything seems to work fine. The external converter is installed too. But i am not shure.

z2m says firmware is 1.0.0 and i have no reset button?

Device type Router
Zigbee Model DONGLE-E_R
Zigbee Manufacturer SONOFF
Description Sonoff Zigbee 3.0 USB Dongle Plus (EFR32MG21) with router firmware
Support status Supported
Firmware build date 20220515
Firmware version 1.0.0
Manufacturer SONOFF
Model ZBDongle-E

The secureCRT terminal says Sonoff v1.0.1 / Gecko Bootloader v1.12.00.

Is everything fine? How can i check if your firmware is flashed?

[Nerivec]

You flashed this file, correct?
https://github.com/Nerivec/silabs-firmware-builder/releases/download/v2024.6.2-update2/sonoff_zbdonglee_zigbee_router_8.0.2.0_115200_sw_flow.gbl

If yes, then trigger a re-interview in Z2M, if not, flash that one, and then re-interview in Z2M.

The Dongle-E will then appear like this in Z2M with this firmware:

[kraus-wagner]

Flashing was ok. The re-interview did it! Now everything is shown correct. Reset button is on details page!

[bangerdemon]

I flashed the file https://github.com/Nerivec/silabs-firmware-builder/releases/download/v2024.6.2-update2/sonoff_zbdonglee_zigbee_router_8.0.2.0_115200_sw_flow.gbl to a brand new Sonoff Dongle E.

It originally showed up in z2m as unsupported. After doing other things in HA, I restarted HA, went into z2m, and the device has now disappeared!

I have tried putting it into pairing mode, but no matter what buttons are pressed, I can't get it back into pairing mode. Using the SiLabs Flasher, it can't find any firmware when I try to connect it to change back to coordinator firmware, and using SecureCRT, I can't get into the bootloader to try flashing again.

Any ideas please?

[bangerdemon]

Now I get an error saying bad indentation!

If I uninstall z2m and then reinstall it, would I need to re pair all of my devices?

[Nerivec]

No, but you don't need to reinstall it, just fixing the indentation should be enough. Can you post the file in question?

[bangerdemon]

Tried it like this

And like this

[Nerivec]

The second one is correct.

PS: If needed, you can find me on Discord, you can DM me after joining the zigbee2mqtt server.

[bangerdemon]

I don't know if this is my problem, but if it is, I have no idea how to change it!

[bangerdemon]

I have sorted it!!🙏

I added the external converter into the z2m add-on configuration, and it just worked.

Thanks for all of your help, much appreciated.

[Nerivec]

Good to hear! 😉
Seems your configuration file and the add-on configuration were out of sync, so it wasn't including it properly.

[adynis]

I need some advices: What firmware shuld I use for Home Assistant (nabucasa) yellow ?

1. With hardware flow control or without ?
2. From where ?

• https://github.com/darkxst/silabs-firmware-builder/tree/ember-nohw/firmware_builds/yellow
• https://github.com/darkxst/silabs-firmware-builder/tree/main/firmware_builds/yellow
• https://github.com/Nerivec/silabs-firmware-builder/releases
• https://github.com/NabuCasa/silabs-firmware/tree/main/EmberZNet
• https://github.com/NabuCasa/silabs-firmware/tree/main/EmberZNet/beta

3. Which version?
   (any version? last one ? )

[Nerivec]

It wouldn't be router firmware for the yellow, so, not quite the right place for this, but here (you'll want the zigbee_ncp one):

• "Stable / Official": https://github.com/NabuCasa/silabs-firmware-builder/releases
• "Edge": https://github.com/Nerivec/silabs-firmware-builder/releases

I update the builds here fairly fast after new changes/releases, hence, you can consider them somewhat similar to the difference between Zigbee2MQTT "normal" branch, and dev/edge branch.

I keep a list with categories for ember-zli, which you might find useful:
https://github.com/Nerivec/ember-zli/blob/main/firmware-links.json

[thk-socal]

Just feedback on performance. I have two Zigbee networks that are using Tubes MGM24 PoE devices. One network with 170 devices and one networks with 190 devices. Just added in the SONOFF Dongle-E as additional routers using the firmware provided and last updated 4 days ago. They both joined without issue and are working perfectly as long as I remember to add the external convertor code to the Z2M installs. Performance seems stellar and networks are stable.

Everything working "out of the box" and perfectly. Thanks for such great work as always!

[adynis]

It wouldn't be router firmware for the yellow, so, not quite the right place for this, but here (you'll want the zigbee_ncp one):

• "Stable / Official": https://github.com/NabuCasa/silabs-firmware-builder/releases
• "Edge": https://github.com/Nerivec/silabs-firmware-builder/releases

I update the builds here fairly fast after new changes/releases, hence, you can consider them somewhat similar to the difference between Zigbee2MQTT "normal" branch, and dev/edge branch.

I keep a list with categories for ember-zli, which you might find useful: https://github.com/Nerivec/ember-zli/blob/main/firmware-links.json

Ohh.... sorry .... my question was totally in the wrong place :( It was about routers, not coordinators 🤦‍♂️
Anyhow, thanks for answering :)

[ortofan]

About to dive into v8.0.2 using 3 SLZB-6M and an SLZB-7 on two HAOS instances.
If I am on all the latest versions, do I still need the external converter?
And if so, what is the best way to handle individual z2m instances on the same system. Rather not park the converter into 3 z2m folder.

[Nerivec]

The external converter is required for router firmware only. For coordinator, you do not need a converter at all.

The converter is still a bit too new to include natively into Z2M, we need a bit more feedback, but hopefully it will make it into the next version (January). Technically, the device should still do its job (routing) even if it says unsupported (no converter), but you will not have the extra features.

[ortofan]

Thanks Nerivec,
Now that I have successfully flashed and deployed 3 SLZB-06M Coordinators, I want to add 3 SLZB-06M based routers as well to 3 individual z2m instances on the same HA host. I rather not copy the same js file to each folder (I tend to forget about these things). How do I handle 3 z2m instances for the external converter? Will the next version of z2m have this built in?

[Nerivec]

Like I said above, we'll see about adding it into the January version. Until then, each Z2M instance needs the file present, so, if not a copy, a symlink, mount, etc. but that's entirely dependent on your setup. If you don't want that, you can just leave it as "unsupported" (no external converter), until the converter is added natively in Z2M; it will still do the routing, you just won't have reporting or buttons available...

[ortofan]

Funny enough, it shows supported and seem to be routing just fine and dandy :) without the converter. So go figure. One thing I noticed that on the SLZB web config page mode shows "cooridnator" after I flashed it clearly with the router. But I guess this is the same thing as the firmware date talked about previously, sort of out of your control.

[Nerivec]

As yes, I forgot that the SLZB06M router has an old converter in Z2M already, so it would show supported, it just won't have the new features of the new converter (yet).
About the coordinator thing, indeed, that's probably related to the SMLight API.

[aldur11]

What's the difference between the Sonoff Dongle-E router FW here vs the 2 year old one found at https://github.com/itead/Sonoff_Zigbee_Dongle_Firmware/blob/master/Dongle-E/Router/Z3RouterUSBDonlge_EZNet6.10.3_V1.0.0.gbl ?

I flashed my Sonoff Dongle-E routers with 2 year old firmware, everything seems to work, but I'm surprised that the routers can only have 20 direct children max. Does the FW here allow for more children?

[Nerivec]

It's updated to latest firmware (8.0.2, v6 is already years old), cleaned up of unnecessary endpoints/clusters and has some extra features to make it easier to deal with (always scanning when not joined to prevent having to open the case for example, or, allowing to enter the bootloader by sending a command from Z2M directly when needing to flash, etc.). Though as mentioned, it requires the use of the provided external converter for now (not yet included into Z2M).
As for the configs, yes, they are quite different, they basically are the equivalent of the current 8.0.2 coordinator version (with a few modifications to avoid unnecessary memory allocation for a router). Values can be seen here:

silabs-firmware-builder/manifests/sonoff/sonoff_zbdonglee_zigbee_router.yaml

Lines 24 to 28 in c015a81

	slcp_defines:
	SL_ZIGBEE_ADDRESS_TABLE_SIZE: 32
	SL_ZIGBEE_MULTICAST_TABLE_SIZE: 26
	SL_ZIGBEE_ROUTE_TABLE_SIZE: 16
	SL_ZIGBEE_DISCOVERY_TABLE_SIZE: 16

silabs-firmware-builder/manifests/sonoff/sonoff_zbdonglee_zigbee_router.yaml

Lines 63 to 83 in c015a81

	SL_ZIGBEE_APS_UNICAST_MESSAGE_COUNT: 64
	SL_ZIGBEE_BROADCAST_TABLE_SIZE: 30
	SL_ZIGBEE_NEIGHBOR_TABLE_SIZE: 26
	SL_ZIGBEE_SOURCE_ROUTE_TABLE_SIZE: 200
	SL_ZIGBEE_MAX_END_DEVICE_CHILDREN: 32
	SL_RAIL_UTIL_RSSI_OFFSET: -11
	# all zigbee channels
	SL_ZIGBEE_AF_PLUGIN_NETWORK_STEERING_CHANNEL_MASK: 0x07fff800
	SL_ZIGBEE_AF_PLUGIN_NETWORK_STEERING_RADIO_TX_POWER: 20
	SL_ZIGBEE_AF_PLUGIN_CONCENTRATOR_CONCENTRATOR_TYPE: HIGH_RAM_CONCENTRATOR
	# <1-60>
	SL_ZIGBEE_AF_PLUGIN_CONCENTRATOR_MIN_TIME_BETWEEN_BROADCASTS_SECONDS: 30
	# <30-300>
	SL_ZIGBEE_AF_PLUGIN_CONCENTRATOR_MAX_TIME_BETWEEN_BROADCASTS_SECONDS: 180
	# <1-100>
	SL_ZIGBEE_AF_PLUGIN_CONCENTRATOR_ROUTE_ERROR_THRESHOLD: 3
	# <1-100>
	SL_ZIGBEE_AF_PLUGIN_CONCENTRATOR_DELIVERY_FAILURE_THRESHOLD: 1

Note that ideally, you would want more routers (dedicated or not), each with a few devices, instead of just one with many devices, to build a proper mesh.

[aldur11]

Thanks for the reply. I completely agree that a sufficient number of routers is needed to form a good mesh.

If I'm reading this correctly, this firmware allows a maximum of 32 direct children. Is that correct?

[Nerivec]

Indeed.
The max is technically 64, but that would be wasting memory that is otherwise allocated to improve buffering capabilities.
A lot of non-dedicated routers (power plugs, bulbs, etc.) have 4-8, some go a little higher...

[antst]

Aside of error I reported in #19 , it looks like router firmware is damn good ) I am running this for couple of weeks on couple of routers and everything is perfect. Even quite sensitive to everything Danfoss TRVs works as a charm behind them.
@Nerivec thanks for this one!

[kraus-wagner]

Some feedback:
i use the latest router firmware on three sonoff dongle-e. My coordinator is a SLZB06-M with latest ZB firmware too (8.0.2.0), and ESP firmware 2.6.8dev21. Everything works like a charm.
Updating of the sonoffs is now very easy. Plug it into the pc, push the reset button on the devices detail page in zigbee2mqtt, device enters bootloader and is ready for flashing. Perfect! Thank you!