Product description

Z-Wave.Me Programmer is a full featured programming tool for development, testing, production and production testing of IoT devices based on Z-Wave, Zigbee, Thread and BLE protocols.

Z-Wave.Me Programmer is able to flash Z-Wave and Zigbee chips by Silicon Labs such as:

• ZGM130S
• ZGM230S
• EFR32ZG23
• EFR32MG21
• MGM210

Package

The Z-Wave.Me Programmer package inclides:

• Z-Wave.Me Programmer
• 2.4 GHz RP-SMA male antenna
• 868 MHz RP-SMA male antenna (for EU)
• 916 MHz RP-SMA male antenna (for US)
• CR2032 coin-cell battery
• Programming cable with IDC-10 female connector
• USB-A to USB-C cable

Connecting

The front panel of the programmer has one programming port an with IDC-10 male 10-pins (2x5) connector with pitch 2.54 mm.

On the top panel there is a status LED and a programming button

The back panel has the USB-C port. This port is used to power the programmer (in autonomous mode) and to flash and upload fimwares in the programmer when connected to a PC.

In addition the programmer has two RP-SMA female connectors for 868/916 MHz (for Z-Wave) and 2.4 GHz antennas (for Zigbee, Thread and BLE). Those antennas are used for production test and as an RF sniffer.

Programming port pinout

The programming cable connector has IDC-10 female connector on one side. On the other side it should be adjusted to your device depending on the programming pads on the PCB. The programmer port is also compatible with the Tag Connect TC2050-IDC cable.

❗ It is important to keep the programming cable length as short as possible. The SWD and SWD/UART protocols used to program chips run on a very high speed.

Programming port pinout:

Chip programming requires only SWDIO, SWCLK, SWO, RESET and GND. If power is not provided to the chip, VCC is also needed.

COM-ports

When connected thru USB the programmer provides 4 COM-ports (appears as ttyUSB0-4 on Linux). Ports of the programmer:

Status LED

The status LED shows the programmer current status and operation progress

Programming button

The programming button can be used to start flashing in autonomous mode.

Software installation

• Z-Wave.Me Programmer Tool for Linux 64 bits
• Z-Wave.Me Programmer Tool for Windows
• Programer RAM binary (for -bri parameter)

Usage

The programmer software has multiple functions.

Get the list of available commands:
zme_prog7 -h

Get specific parameters for each command:
zme_prog7 <command> -h

Common options for all commands:

Show info

Show programmer device information:
zme_prog7 info -d DEVICE [-b BAUDRATE]

Listing keys

Prints firmware encryptioin keys in the programmer:
zme_prog7 keys -d DEVICE [-b BAUDRATE]

Load key

Loads firmware encryptioin keys in the programmer:
zme_prog7 loadKey -d DEVICE [-b BAUDRATE] [-i SLOT_INDEX] package

Clear key

Remove firmware encryption key from the programmer:
zme_prog7 clearKey -d DEVICE [-b BAUDRATE] [-i SLOT_INDEX]

Listing slots

List occupied slots and free memory of the programmer:
zme_prog7 slots -d DEVICE [-b BAUDRATE]

Update the programmer

Update the programmer firmware using a file in .pkzme format:
zme_prog7 update -d DEVICE [-b BAUDRATE] filename

Update the programmer secure engine

Update the programmer secure engine firmware using a file in .pkzme format:
zme_prog7 update_se -d DEVICE [-b BAUDRATE] filename

Update the programmer bootloader

Update the programmer bootloader using a file in .pkzme format:
zme_prog7 update_bootloader -d DEVICE [-b BAUDRATE] filename

Load license

Load a license string in the programmer:
zme_prog7 lic -d DEVICE [-b BAUDRATE] license

Change count

Set max programming count for custom (non Z-Wave.Me) firmwares:
zme_prog7 count_custom -d DEVICE [-b BAUDRATE] [-c count_current] [-cm count_max] key

Load image

Load a file in .pkzme format in a specific slot:
zme_prog7 loadImage -d DEVICE [-b BAUDRATE] [-i SLOT_INDEX] filename

New slot

Create a new slot of a specific size:
zme_prog7 push -d DEVICE [-b BAUDRATE] -s SIZE

In most cases this is not needed as loadImage command will create a new slot with the required size. Use this command if you develop and want to allocate a slot to reload the re-compiles image keeping the same slot index.

Factory reset

Erase all slots and factory reset the programmer:
zme_prog7 reset -d DEVICE [-b BAUDRATE]

Production flash firmware

Flash the connected device using slots:
zme_prog7 app -d DEVICE [-b BAUDRATE] [-fi FIRMWARE_INDEX] [-bi BOOTLOADER_INDEX] [-ki KEY_INDEX] [-bri BOOTLOADER_RAM_INDEX] [-chip CHIP] [-sei SEI_INDEX] [-o {DSK}] [-u USER_DATA]

OTA Key load

Load the OTA upgrade key in the connected device:
zme_prog7 loadOTAKey [-token_encrypt TOKEN_ENCRYPT] [-token_sign TOKEN_SIGN] -d DEVICE [-b BAUDRATE] [-chip CHIP]

OTA keys are generated using the Silicon Labs Simplicity Studio:

commander.exe gbl keygen --type keygen --type aes-ccm -o encrypt.key
commander.exe gbl keygen --type ecc-p256 --outfile sign.key

Flash binary

Flash a binary file in .bin or .hex format into the connected device:
zme_prog7 flash [-addr ADDRESS] -d DEVICE [-b BAUDRATE] [-chip CHIP] filename

Flash read

Read the flash memory of the connected device:
zme_prog7 flash_read [-addr ADDRESS] [-len LENGHT] [-o OUT_FILE] -d DEVICE [-b BAUDRATE] [-chip CHIP]

Flash write

Write to the flash memory of the connected device:
zme_prog7 flash_write [-addr ADDRESS] [-data DATA] -d DEVICE [-b BAUDRATE] [-chip CHIP]

Page erase

Erase the flash memory page in the connected device:
zme_prog7 pageerase [-addr ADDRESS] [-len LENGHT] -d DEVICE [-b BAUDRATE] [-chip CHIP]

Mass erase

Full flash erase in the connected device:
zme_prog7 masserase -d DEVICE [-b BAUDRATE] [-chip CHIP]

Checks if locked

Checks if the connected device is locked:
zme_prog7 isLocked -d DEVICE [-b BAUDRATE] [-chip CHIP]

Lock

Lock the connected device :
zme_prog7 lock -d DEVICE [-b BAUDRATE] [-chip CHIP]

Unlock

Unlocks the connected device:
zme_prog7 unlock -d DEVICE [-b BAUDRATE] [-chip CHIP]

The flash content is fully erased during this operation (in some chips bootloader and Secure Engine content is not erased)

UART Serial API speed

Set the UART Serial API speed:
zme_prog7 uart_sapi [-new NEW] [-b BAUDRATE] -d DEVICE

Set the speed of communications with the programmer. Higher speed requires good USB cable.

SWD speed

Set the SWD speed:
zme_prog7 swd_set [-new NEW] [-b BAUDRATE] -d DEVICE

This speed is used to flash via SWD the special UART boot firmware (provided by the programmer). Once flashed, the programmer will switch to this UART to load the target firmware to the device. Higher speed requires short cable.

UART SWD speed

Set the UART SWD speed:
zme_prog7 uart_swd_set [-new NEW] [-b BAUDRATE] -d DEVICE

This speed is used to flash via UART the target firmware special. This step comes after flashing the special UART firmware (provided by the programmer). Higher speed requires short cable.

Set RTC

Set time in the programmer to system time:
zme_prog7 rtc_set -d DEVICE [-b BAUDRATE]

This command should be used on each power on if the programmer have no battery inserted. To preserve the time without power, the battery should be inserted.

Use cases

This programmer is a very powerful tool. Below you can find the typical use cases.

Flash a binary file

When developing, one typically want to flash the Secure Engine firmware (should be done once), the bootloader and the firmware. Here is an example:

zme_prog7 flash s2c1_se_firmware.hex -c EFR32MG21A020F1024IM32 -d /dev/ttyUSB2
zme_prog7 masserase -c EFR32MG21A020F1024IM32 -d /dev/ttyUSB2
zme_prog7 loadOTAKey -token_encrypt ota_encrypt.key -token_sign ota_sign.key -c EFR32MG21A020F1024IM32 -d /dev/ttyUSB2
zme_prog7 flash bootloader.hex -c EFR32MG21A020F1024IM32 -d /dev/ttyUSB2
zme_prog7 flash firmware.hex -c EFR32MG21A020F1024IM32 -d /dev/ttyUSB2

Secure Engine bootloader is typically taked from SiLabs git. If the connected device is based on a chip that does not have a Secure Engine, skip the step with loading Secure Engine firmware.

The bootloader and the firmware are compiled using the Simplicity Studio.

Prepare to production

You can load files in the programmer, set the flash counter with the license and send it to the factory for production.

.pkzme files are encrypted and can be safely sent over the internet.

Data in slots can not be extracted back from the programmer. This ensures your intellectual property safety keeping things simple for the factory.

zme_prog7 reset -d /dev/ttyUSB2
zme_prog7 loadImage BootloaderRam.pkzme -d /dev/ttyUSB2
zme_prog7 loadImage Bootloader.pkzme -d /dev/ttyUSB2
zme_prog7 loadImage Firmware.zwaveme.pkzme -d /dev/ttyUSB2
zme_prog7 loadImage s2c1_se_firmware.zwaveme.pkzme -d /dev/ttyUSB2
zme_prog7 loadImage ota_key.pkzme -d /dev/ttyUSB2

On the factory use app command to flash each device.

Production flash

The factory will use the following command to flash each device.

zme_prog7 app -bri 0 -bi 1 -fi 2 -sei 3 -ki 4 -c EFR32MG21A020F1024IM32 -d /dev/ttyUSB2

Load a licence

The license sets the number of allowed flash operations (flash counter). This ensures the factory can't produce more devices you ordered. Always have 10% extra count for rework on the factory side.

Data in slots is encrypted and can not be extracted from the programmer. This ensures your intellectual property safety keeping things simple for the factory.

Upgrade the programmer firmware

Upgrade to the latest programmer firmware:

zme_prog7 update -d /dev/ttyUSB2 Programmer_EFR32MG21.programmer.pkzme

Sometimes you might need to update the Secure Engine and the bootloader too:

zme_prog7 update_bootloader -d /dev/ttyUSB2 Programmer_EFR32MG21_bootloader.programmer.pkzme
zme_prog7 update_se -d /dev/ttyUSB2 Programmer_EFR32MG21_SE.programmer.pkzme
zme_prog7 update -d /dev/ttyUSB2 Programmer_EFR32MG21.programmer.pkzme

Technical specifications

Troubleshooting

Requirements

Software requirements: TBD

Document revision