tube0013/tubeszb_addons

Home Assistant add-ons for Flashing TubesZB Devices

TubesZB Home Assistant add-on repository

Addon-ons for Home Assistant that allow you to easily flash new firmware on your TubesZB Coordinators

Add-ons provided by this repository

• TubesZB TI CC2652 FW Flasher

  Flash FW to TubesZB TI CC2652 based Coordinators

• TubesZB Silicon Labs FW Flasher

  Flash FW to TubesZB SiliconLabs EFR32 based Coordinators

• TubesZB Zigpy-CLI Tools

  Use the Zigpy-CLI in an add-on!

Installation

Click on the button below:

Or, in your Home Assistant, navigate to Configuration > Add-ons, Backups & Supervisor > Add-on Store > ... > Repositories and add https://github.com/tube0013/tubeszb_addons to the list.

Credits

The libraries that tools in this addons are based on:

• beagleconnect / cc1352 flasher
• JelmerT / cc2538-bsl

Thanks to the following as well - developers and contributors:

• @tmercenaruss for the updated cc1352-flasher using sockets for faster network flashing and other ideas!
• @home-assistant for the orginal Silicon Labs Flasher for which these addons were based.

tubeszb_addons's Issues

Typo in the print when triggering info command: "INFO: Directoty Exists"

Directoty --> Directory

[REQUEST] Ability to "Write IEEE address" (i.e. option to change IEEE address) with the tzb-silabs-flasher add-on

Consider adding ability to write IEEE address (i.e. option to add/change secondary EUI64 IEEE) with tzb-silabs-flasher add-on.

Similar feature request as in #4 but for tzb-silabs-flasher add-on to allow same on Silicon Labs based EmberZNet/Ember adapters.

This normally needs to be done when migrating an existing Zigbee network to a new adapter or otherwise replacing a broken Zigbee Coordinator by restoring backup to a new adapter. See:

https://www.zigbee2mqtt.io/guide/adapters/flashing/copy_ieeaddr.html

"When migrating from one stick to another it is important that the new stick uses the same ieee address as the old stick. Some devices lookup the coordinator by its ieee address, this fails when the ieee address of the coordinator changes. There are various tools which can do this."

Not sure if can write secondary or primary IEEE address to Silabs EFR32/EZSP adapters with Nabu Casa's universal-silabs-flasher?

UPDATE! Writing node IEEE address should be possible with the Universal Silicon Labs Flasher from Nabu Casa:

https://github.com/NabuCasa/universal-silabs-flasher#writing-ieee-address

https://github.com/NabuCasa/universal-silabs-flasher/blob/dev/README.md#writing-ieee-address

Or if anything more can be done via bellows CLI tools that can not also be done via zigpy-cli CLI tools?

References:

https://community.silabs.com/s/question/0D51M00007xeL3QSAU/how-to-read-ieee-eui64-from-efr32-mcu

[REQUEST] Ability to "Write IEEE address" (i.e. option to change IEEE address) with the tzb-cc2652-flasher add-on

Request add ability to write IEEE address (i.e. option to add/change secondary IEEE address) with the tzb-cc2652-flasher add-on.

Assume possible since based on cc1352-flasher which is turn is a fork of cc2538-bsl which has a feature capable of that function?

ZigStar Multi Tool and cc2538-bsl allow users to "Write secondary IEEE" but would also be great if could do it via this HA addon:

https://www.zigbee2mqtt.io/guide/adapters/flashing/copy_ieeaddr.html

ZigStar Multi Tool
Supports: CC2652, CC1352, CC2538

1. Download and run the tool
2. Plug in your adapter and put it in BSL mode, consult your adapters manual on how to put it in BSL mode
3. Click refresh icon and select your adapter
4. Fill in the old coordinators ieee address under "IEEE" (first 0x can be skipped)
5. Check "Write IEEE" and click "Write IEEE"
6. Reflash the firmware on your stick (this is important, otherwise the coordinator will not use the new ieee address)

cc2538-bsl
Supports: CC2652, CC1352, CC2538

1. Download the tool
2. Plug in your adapter and put it in BSL mode, consult your adapters manual on how to put it in BSL mode (if necessary, some adapters have an autobootloader, e.g. this one)
3. Run ./cc2538-bsl.py -evw --ieee-address 00:12:4b:aa:bb:cc:dd:ee -p /dev/tty.usbserial-10 ./fw.hex, replace:
   • 00:12:4b:aa:bb:cc:dd:ee with your coordinator ieee address (first 0x can be skipped)
   • /dev/tty.usbserial-10 with the path to your adapter
   • ./fw.hex with the path to your adapters firmware.

FLASH-PROGRAMMER-2
Supports: CC2652, CC1352, CC2538

1. Download the tool
2. Plug in your adapter and put it in BSL mode, consult your adapters manual on how to put it in BSL mode
3. Select your adapter, go to "MAC address"
4. Fill the old coordinator ieee address into "Secondary Address" -> "IEEE 802.15.4 MAC address" (first 0x can be skipped)
5. Press "Write"
6. Reflash the firmware on your stick - in the right corner under Secondary MAC check "Retain secondary IEEE" (this is important, otherwise the coordinator will not use the new ieee address)

PS: Note that the primary ieee address will remain the same and these instructions only change the secondary ieee address. The tools generally only show the primary ieee address, so it can appear that the changes aren't taking effect. Setting the secondary ieee address via the instructions below is sufficient to avoid the problem mentioned above.

Warning unknow device

Hello.
Im trying to backup my conbee2 before trying to migrate my network to a conbee3.

I launch the addon and export a file that seams good but apears a error in log

`[13:58:19] INFO: Running zigpy - backup on /dev/ttyACM0 to /config/tzb-zigpy-cli-tools/backup_conbee2_log_err.json

2024-03-15 13:58:19.780 d0f5a498-tzb-zigpy-cli-tools zigpy.application WARNING Unknown device AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x8F4F)

2024-03-15 13:58:19.791 d0f5a498-tzb-zigpy-cli-tools zigpy.application WARNING Unknown device AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x9129)

2024-03-15 13:58:19.804 d0f5a498-tzb-zigpy-cli-tools zigpy.application WARNING Unknown device AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x9129)

[13:58:19] INFO: Action Complete`

What means this warning? its important?

thanks a lot!
-David-

[REQUEST] Look at patches from darkxst for his multipan flasher fork of the Silabs Flasher

FYI, @darkxst has a downstream fork of Silabs Flasher add-on with patches that might be interested in looking at for your fork:

https://github.com/darkxst/multipan_flasher

https://github.com/darkxst/multipan_flasher/pulls?q=is%3Apr

https://github.com/darkxst/multipan_flasher/blob/main/multipan_flasher/DOCS.md

Thinking that perhaps him and you are also interested in collaborating on some patches from your own Silabs Flasher fork:

https://github.com/tube0013/tubeszb_addons/tree/main/tzb-silabs-flasher

https://github.com/tube0013/tubeszb_addons/blob/main/tzb-silabs-flasher/DOCS.md

[REQUEST] CC253x (CC2530/CC2531) flasher via zigpy-znp CLI tools

Since already have other flashers could be nice to add a "TubesZB: TI CC253x Flasher Add-on" based on zigpy-znp CLI tools?

FYI, zigpy-znp can be used as stand-alone command line tool to flash Zigbee NCP application firmware CC2530/CC2531 adapters:

• https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md
  • https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md#cc2531-tools
    • https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md#flash-operations
      • https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md#flash-read
      • https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md#flash-write

It would probably be a good idea to backup old firmware to file by default so there is an option to go back to the old version.

PS: Probably also be a good idea if it was possible to by default do an automation Zigbee network backup before flashing -> #2

[REQUEST] Add command to probe running firmware to the tzb-zigpy-cli-tools add-on?

Suggest add command in zigpy-cli for tzb-zigpy-cli-tools to probe running firmware that dump EmberZNet Ember config via EZSP.

These feature/commands are not supported by zigpy-cli but are supported via bellows CLI tools:

https://github.com/zigpy/bellows

$ bellows -d /dev/ttyUSB1 -b 115200 config --all

and

$ bellows -d /dev/ttyUSB1 -b 115200 info

FYI, @darkxst also added a wrapper for this command to universal-silabs-flasher here -> NabuCasa/universal-silabs-flasher#37

If a unified command for this could be added to upstream zigpy-cli then then assume that such zigpy CLI command could later be extended to offer similar information probe in other radio libraries for zigpy too?

PS: Also related to this feature request from by xconverge asking to probe Silabs bootloader -> NabuCasa/universal-silabs-flasher#16

universal-silabs-flasher --device /dev/ttyUSB0 --probe-method bootloader

Missing required option 'network_device' in TubesZB Zigpy-CLI Tools

Can't start/configure the Plugin, since it says that "'network_device' is a required option".
I selected the Serial Device, and have the Option Network Device disabled.
Seems like a Handy tool for some Zigbee-Commands, hoping to get it working and check out the Options!

[REQUEST] Add Zigbee network backup to file and restore features to tzb-zigpy-cli-tools

@tube0013 Please consider adding feature options Zigbee network backup to file and restore features to tzb-zigpy-cli-tools.

This would be especially helpful to Zigbee2MQTT users for adapter migration when they have Silicon Labs and ConBee/RaspBee based Zigbee Coordinator radio dongles as the zigbee-herdsman library Z2M depends on currently only support Texas Instruments based adapters.

Zigbee2MQTT users can already manually install and use zigpy-cli to create a manual backup to file of their Zigbee network from their old Zigbee Coordinator regardless of which radio type it is based on and then restore that backup from file to a new adapter.

For example, a Zigbee network backup will allow you to migrate from a old TI CC2531 with Z-Stack Home 1.2 or an old Silabs EM35xx to a newer CC2652 or EFR32MG21 based Zigbee Coordinator without having to manually re-pair/re-join any devices. You can even migrate from older ConBee and RaspBee (deconz firmware based) adapters as long as you first upgrade their firmware.

For reference see:

• Koenkk/zigbee2mqtt#16478
• Koenkk/zigbee-herdsman#665
• Koenkk/zigbee-herdsman#319

zigpy-cli can backup and restore Zigbee network to/from file allow Zigbee2MQTT users to backup and migrate radio types:

https://github.com/zigpy/zigpy-cli/blob/dev/README.md#network-backup

https://github.com/zigpy/zigpy-cli/blob/dev/README.md#network-restore

Note! Restoring backups using zigpy-cli automatically copy the same IEEE to a new adapter and that way the Zigbee gateway application thinks it is the same adapter, but the end user themselves would still need to manually change serial config for port, adapter (i.e. radio type), and/or baudrate in their configuration.yaml for Z2M config if they changed from for example Silicon Labs to Texas Instruments or firmware:

https://www.zigbee2mqtt.io/guide/faq/#how-do-i-migrate-from-one-adapter-to-another

https://www.zigbee2mqtt.io/guide/configuration/

PS: ZHA and Zigbee2MQTT gateway backups are not compatible even though both use "Open ZigBee Coordinator Backup Format" because the Zigbee network backup is only a high-level and stack-agnostic backup of your device's network data (written in the Open Coordinator Backup Format) but it at least allows you to snapshot the device state and move your network between any hardware and firmware versions supported by zigpy-cli. This backup format is human-readable and fully documented so users have to option to manually fill out or change the appropriate information by hand to form a network if they are migrating from a Zigbee Coordinator that is not currently supported.

https://github.com/zigpy/open-coordinator-backup