Metadata-Version: 2.4
Name: universal-silabs-flasher
Version: 1.1.0
Summary: Tool to flash firmware onto any Silicon Labs radio running EmberZNet, CPC multi-PAN, or just a bare Gecko Bootloader
Author-email: Puddly <puddly3@gmail.com>
License: GPL-3.0
Project-URL: repository, https://github.com/NabuCasa/universal-silabs-flasher
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: tqdm
Requires-Dist: zigpy>=1.3.0
Requires-Dist: crc
Requires-Dist: bellows>=0.49.0
Requires-Dist: gpiod; platform_system == "Linux"
Requires-Dist: coloredlogs
Requires-Dist: typing_extensions
Provides-Extra: testing
Requires-Dist: pytest>=7.3.1; extra == "testing"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "testing"
Requires-Dist: pytest-timeout>=2.1.0; extra == "testing"
Requires-Dist: pytest-mock>=3.10.0; extra == "testing"
Requires-Dist: pytest-cov>=4.1.0; extra == "testing"
Requires-Dist: pytest-github-actions-annotate-failures; extra == "testing"
Dynamic: license-file

# Universal Silicon Labs Flasher
Automatically communicates with radios over CPC, EZSP, or Spinel to enter the bootloader and then flashes a firmware image with XMODEM.

## Installation
```console
$ pip install universal-silabs-flasher
```

## Usage

```console
usage: universal-silabs-flasher [-h] [-v] [--device DEVICE] [--probe-methods PROBE_METHODS]
                                [--bootloader-reset BOOTLOADER_RESET]
                                {dump-gbl-metadata,probe,write-ieee,flash} ...

positional arguments:
  {dump-gbl-metadata,probe,write-ieee,flash}

options:
  -h, --help            show this help message and exit
  -v, --verbose
  --device DEVICE
  --probe-methods PROBE_METHODS
                        Comma-separated list of application type and baudrate pairs to use when probing the device.
                        Each pair should be in the format '<application_type>:<baudrate>'. Valid application types:
                        bootloader, cpc, ezsp, spinel, router. Example: 'ezsp:115200,ezsp:460800,spinel:460800'
  --bootloader-reset BOOTLOADER_RESET
                         Reset methods to attempt when triggering bootloader mode. Multiple methods can be chained by
                         separating them with a comma. Valid values: yellow, ihost, slzb07, rts_dtr, baudrate
```

For `flash`, you can also pass `--profile` to use a predefined device profile.
`--profile` cannot be combined with `--probe-methods` or `--bootloader-reset`.

## Flashing firmware
For safety, firmware GBL image files are validated and their checksums verified both before sending, and by the device bootloader itself.

### Yellow
The Yellow's bootloader can always be activated with the `--bootloader-reset yellow` option:

```bash
$ universal-silabs-flasher \
    --device /dev/ttyAMA1 \
    --bootloader-reset yellow \
    flash \
    --firmware NabuCasa_RCP_v4.1.3_rcp-uart-hw-802154_230400.gbl
```

### SkyConnect
The SkyConnect will be rebooted into its bootloader from the running application: either EmberZNet or CPC.

```bash
$ universal-silabs-flasher \
    --device /dev/cu.SLAB_USBtoUART \
    flash \
    --firmware NabuCasa_SkyConnect_EZSP_v7.1.3.0_ncp-uart-hw_115200.gbl
```

### Home Assistant Connect ZBT-2
The Home Assistant Connect ZBT-2 can use the built-in `zbt2` profile:

```bash
$ universal-silabs-flasher \
    --device /dev/ttyACM0 \
    flash \
    --profile zbt2 \
    --firmware zbt2_openthread_rcp_2.4.4.0_GitHub-7074a43e4_gsdk_4.4.4.gbl
```

### Sonoff ZBDongle-E
The Sonoff dongles use the RTS/DTR bootloader reset method:

```bash
$ universal-silabs-flasher \
    --device /dev/ttyUSB0 \
    --bootloader-reset rts_dtr \
    flash \
    --firmware ncp-uart-hw-v7.4.5.0-zbdonglee-115200.gbl
```


## Writing IEEE address
Ensure a target device running EmberZNet firmware has the correct node IEEE address:

```bash
$ universal-silabs-flasher \
    --device /dev/cu.SLAB_USBtoUART \
    write-ieee \
    --ieee 00:3c:84:ff:fe:92:bb:2c
```

The IEEE address can also be specified without colons: `--ieee 003c84fffe92bb2c`.

If the current device's IEEE address already matches the provided one, the command will not write it unnecessarily.
Depending on firmware version, writing the IEEE address can be a **permanent** operation. If this is the case,
you will need to upgrade the firmware on your adapter to a more recent release of EmberZNet or perform the one-time
write with `--force`.