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.

The Z-Wave.Me programmer can flash the following families of chips from Silicon Labs. For more detailed and accurate information, use Chip support:

• ZGM130S
• ZGM230S
• EFR32ZG23
• MGM21
• EFR32MG21
• EFR32MG24

The programmer can be used to manipulate the chip (lock, unlock, reboot), flash a file or flash from the internal programmer storage (called slot).

Package

The Z-Wave.Me Programmer package includes:

• 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 and USB-C to USB-C cable

Connecting

The front panel of the programmer has one programming port 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. You can configure how the button works using the command Button set

The back panel has a USB-C port. This port is used to power the programmer and to flash and upload firmware 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 an IDC-10 female connector on one side. The other side of 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. You can adjust the speed using the command Config speed

The programming port pinout configuration can be seen using the Pinout info command and customized using the Pinout set command. Default pinout is shown below:

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

COM-ports

When connected through 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

You can configure the button action using the command Button set

Create a preset with a command Preset set and assigning it to the button Button set - this will allow you to initiate flashing using the button bypassing the terminal.

Z-Wave.Me software installation

• Programmer Tool
• Programmer Tool Changelog
• Programmer Firmware Changelog

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 most commands:

Info

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

Chip info

Shows information about the chip connected via SWD to the programmer:
zme_prog7 chipInfo -d --device [-b --baudrate]

Chip support

Displays the list of chips that you can work with. If you do not specify [-d --device] it will display chips supported by zme_prog7:
zme_prog7 chipSupport [-d --device] [-b --baudrate]

Chip lock

Lock the connected chip to prevent read-back of the firmware:
zme_prog7 chipLock -d --device [-b --baudrate]

After locking the chip, the programmer will not be able to work with the chip anymore. To unlock the chip back, use: Chip unlock. Unlocking will erase the existing firmware from the chip.

After locking the chip, if you use Chip info, you will see:

Chip unlock

Unlock the connected device:
zme_prog7 chipUnlock -d --device [-b --baudrate]

After this, the programmer will be able to fully work with the chip

❗This command will delete almost all chip data - be careful

Chip reboot

Reboot the connected device:
zme_prog7 chipReboot -d --device [-b --baudrate]

Performs a hard reboot of the connected chip. For this action, the RESET pin is used. For more details check the Programming port pinout

Slot info

Prints available and occupied slots of the programmer:
zme_prog7 slotInfo -d --device [-b --baudrate]

You can load into slots using Slot store, reset their contents Slot reset

Slot store

Loads signed image into a slot of the programmer:
zme_prog7 slotStore <filename> -d --device [-b --baudrate] [-i --index]

Slot reset

Clears slots previously written using the command Slot store, You can see which slots are used Slot info:
zme_prog7 slotReset -d --device [-b --baudrate] [-i --index]

❗Be careful all data is permanently deleted

Key info

Shows all available keys:
zme_prog7 keyInfo -d --device [-b --baudrate]

You can download the key using Key store, or delete the command Key reset

Key store

Loads keys into your programmer for loading pkzme files using the command Slot store:
zme_prog7 keyStore <package> -d --device [-b --baudrate] [-i --index]

Key reset

Removes keys:
zme_prog7 keyReset -d --device [-b --baudrate] [-i --index]

Key generate

Creates a hex string representing the key for pkzme signing:
zme_prog7 keyGen <uuid> -p --profile -k --key [-b --baudrate]

Update

Checks for new version and, if necessary, update this software:
zme_prog7 update [-p --profile] -d --device [-b --baudrate]

Erase Page

Erase area in the flash memory of the connected chip:
zme_prog7 erasePage -a --address -l --length -d --device [-b --baudrate]

❗Data is permanently deleted

Erase Mass

Erase the main flash memory of the connected chip:
zme_prog7 eraseMass -d --device [-b --baudrate]

You can see the structure of flash memory using Chip info - This command will clear the memory Flash address and size Flash size

❗Data is permanently deleted

Flash Data

Allows you to write data to the flash of the connected chip:
zme_prog7 flashData -a --address -da --data -d --device [-b --baudrate]

If you already have data on the flash memory, you might need to erase it first. It is only possible to override data from 1 to 0, but not from 0 to 1. In the latter case, you will need to erase first using Erase Page or Erase Mass

Flash read

Allows you to read the contents of the flash memory of the connected chip with the ability to display it in a terminal or save it to a file:
zme_prog7 flashRead -a --address -l --length -d --device [-o --outFile] [-b --baudrate]

❗It is not possible to read flash memory if the chip was locked

Flash file

Write file content into the flash memory of the connected device:
zme_prog7 flashFile <filename> -d --device [-a --address] [-b --baudrate]

Check examples of usage for more info.

Flash product

Flashes the connected programmer using the firmware loaded into the programmer with the command Slot store:
zme_prog7 flashProduct -d --device [-b --baudrate] [-fi --firmwareIndex] [-bi --bootloaderIndex] [-ki --keyIndex] [-sei --seIndex] [-c --chip] [-u --userData] [-o --options] [-qr --qrCodeDir] [-dp --deviceProfile]

If the firmware downloaded by Slot store was encrypted, then the number of times you can flash it is limited by the license

If you don’t explicitly specify all or some of the parameters, it will try to select it yourself

Logging is also carried out into external flash memory; you can view the contents of the log using the command Log info

Config speed

Set the communication speed with the programmer:
zme_prog7 configSpeed -d --device [-sapi --sapi] [-swd --swd] [-uart --uart] [-pti --pti] [-b --baudrate]

License

Load a Z-Wave.Me license package in the programmer:
zme_prog7 lic <package> -d --device [-b --baudrate]

You can see the current license status LICENSE

Check examples of using for use cases

License custom

Load a custom license package in the programmer:
zme_prog7 licCustom <package> -d --device [-b --baudrate]

The package can be generated using the command License custom generate

You can see the current license status LICENSE CUSTOM

License custom generate

Generate a custom license package in the programmer:
zme_prog7 licCustomGen <uuid> -d --device [-b --baudrate]

You can see the current license status LICENSE CUSTOM

You can install the newly generated license using the command License custom

File info

Show the pkzme file info:
zme_prog7 fileInfo <filename> -d --device

Path to the pkzme file you want to get information about

You can create your own pkzme file using File sign To do this, you will first need to create your key using File generate key

File sign

Allows you to create a pkzme file from firmware (compiled using SiLabs SDK) using your created key File generate key:
zme_prog7 fileSign <filename> -c --chip -obj --pkzmeObj -d --device [-o --output] [-p --profile] [-b --baseAddr] [-sv --seVersion]

File extract

Allows you to unpack previously created pkzme files, File sign:
zme_prog7 fileExtract <filename> -d --device [-o --output] [-p --profile]

File generate key

Generates key files for files gbl and pkzme :
zme_prog7 fileGenKey <path> -t --type -d --device

Pinout set

Allows you to configure the IDC-10 programmer pinout:
zme_prog7 pinoutSet -d --device [-b --baudrate] [-o --options] [-r --reset]

Button Info

Shows information about the actions assigned to the programmer button:
zme_prog7 buttonInfo -d --device [-b --baudrate]

You can assign an action to a button to the programmer using the command Button Set

Button Set

Assigns an action to the programmer button:
zme_prog7 buttonSet -a --action -d --device [-b --baudrate]

You can currently assigned function using the Button Info command

RTC set

Set time in the programmer to system time:
zme_prog7 RTCSet -d --device [-b --baudrate] [-ts --timestamp]

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

You can see what time is currently set using RTC

Log info

Displays log of the programmer:
zme_prog7 logInfo -d --device [-b --baudrate] [-o --output]

Information is recorded during use Flash product and also when pressing the programmer button, if a similar action is assigned their Button Set

Log Reset

Reset the log file in the programmer:
zme_prog7 logReset -d --device [-b --baudrate]

❗Be careful, the full log will be deleted so do not forget to save the log before using the Log info command

Preset Info

Shows all saved presets:
zme_prog7 presetInfo -d --device [-b --baudrate]

You can install presets using Preset set

Preset Set

Generates a preset based on the firmware previously loaded into the programmers via the command Slot store:
zme_prog7 presetSet -d --device [-b --baudrate] [-fi --firmwareIndex] [-bi --bootloaderIndex] [-ki --keyIndex] [-sei --seIndex] [-c --chip] [-u --userData] [-o --options] [-i --index] [-n --name]

If you don’t explicitly specify all or some of the parameters, it will try to select it yourself

A total of 10 presets can be saved and used

You can assign presets to a button using Button Set

Preset Reset

Resets presets installed via Preset Set:
zme_prog7 presetReset -d --device [-b --baudrate] [-i --index] [-n --name]

If no [-i --index] or [-n --name] is specified, then it will delete all presets

Radio Test

Allows you to run the radio in different modes:
zme_prog7 radioTest -m --mode -fr --freq -c --channel -p -power -t --timeout -d --device [-b --baudrate]

The command works asynchronously, that is, while the radio is operating, the programmer can execute other commands

You can see what state the radio is in now using RADIO

For more info, check examples of usage

Radio Send Packet

Allows you to send meaningful data while in MODEM mode:
zme_prog7 radioSendPacked -p --packet-d --device [-b --baudrate]

Radio Stop

Allows you to stop the radio:
zme_prog7 radioStop -d --device [-b --baudrate]

You can start the radio using the command Radio Test

Storage Info

Displays service information about the state of the programmer file storage:
zme_prog7 storageInfo -d --device [-b --baudrate]

Use cases

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

Example: 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 flashFile s2c1_se_firmware.hex -d /dev/ttyUSB2
zme_prog7 flashFile <key> -d /dev/ttyUSB2
zme_prog7 flashFile bootloader.hex  -d /dev/ttyUSB2
zme_prog7 flashFile firmware.hex  -d /dev/ttyUSB2
                

Secure Engine bootloader is typically take 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 SiLabs Simplicity Studio.

Example: Load a licence from Z-Wave.Me

The license sets the number of allowed flash operations (flash counter). This ensures the factory can't produce more devices you ordered. Always have a 5-10% extra count for rework at 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.

Example: Mass flash a product

For mass flashing of a product, load files in slots (from a .zip file or individually one by one). Then use a button or a command to flash the product.

Preparing the production from zip:

zme_prog7 slotStore firmware_pack.zip  -d /dev/ttyUSB2
                

Preparing the production from zip:

zme_prog7 slotStore s2c1_se_firmware.pkzme -d /dev/ttyUSB2
zme_prog7 slotStore firmware.pkzme -d /dev/ttyUSB2
zme_prog7 slotStore bootloader.pkzme -d /dev/ttyUSB2
zme_prog7 slotStore key.pkzme -d /dev/ttyUSB2
                

Flahing (with user-data):

zme_prog7 flashProduct -u "014704010301ff00000001010F010E030Dffffffffffffffffffffffffffff19f0" -d /dev/ttyUSB3 -c EFR32ZG23B020F512IM48
                

Example radio tests

Production or FCC/CE certification tests examples:

Zigbee on 2405 MHz:
zme_prog7 radioTest -m PN9 -c 11 -fr 2P4GHZ -p 200 -t 10000 -d COM5

Zigbee on 2440 MHz:
zme_prog7 radioTest -m PN9 -c 18 -fr 2P4GHZ -p 200 -t 10000 -d COM5

Zigbee on 2480 MHz:
zme_prog7 radioTest -m PN9 -c 26 -fr 2P4GHZ -p 200 -t 10000 -d COM5

BLE 2 Mbps on 2402 MHz:
zme_prog7 radioTest -m PN9 -c 0 -fr BLE_2MBPS -p 200 -t 10000 -d COM5

BBLE 2 Mbps on 2440 MHz:
zme_prog7 radioTest -m PN9 -c 19 -fr BLE_2MBPS -p 200 -t 10000 -d COM5

BLE 2 Mbps on 2480 MHz:
zme_prog7 radioTest -m PN9 -c 39 -fr BLE_2MBPS -p 200 -t 10000 -d COM5

Technical specifications

Troubleshooting

Requirements

Software requirements: TBD

Document revision

Channels and modulation

802.15.4 PHY (Zigbee, Thread, Matter)

Zigbee channels are numbered from 11 to 26.

Modulation is OQPSK.

Channel bandwidth is 250 kbps.

Bluetooth Low Energy

Bluetooth Low Energy channels are numbered from 0 to 39. Channels 37, 38, and 39 are Advertising channels.

Modulation depends on the bandwidth:

• GFSK on 125 kbps and 500 kbps
• DQPSK on 2 Mbps
• 8-DPSK on 1 Mbps

The tool uses RF channels 0..39 that corresponds to frequencies 2402..2480 MHz. See the table below for the mapping between the RF channel and the BLE Data/Advertising channel index.