-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
1568 lines (1497 loc) · 86.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>Z-Wave.Me Programmer for Z-Wave and Zigbee chips</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script src="js/index.js" defer></script>
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<aside class="side-menu open">
<nav>
<div class="side-menu-header">
<div class="close" onclick="toggleMenu()"></div>
</div>
<div>
<img src="pics/Z-Wave-Me.png" alt="Z-Wave.Me">
</div>
<h3>Z-Wave.Me Programmer Manual</h3>
<ul class="ChildLinks">
<li><a href="#ProductDescription">Product Description</a></li>
<li><a href="#Package">Package</a></li>
<li><a href="#Connecting">Connecting</a></li>
<li><a href="#Pinout">Programming Port Pinout</a></li>
<li><a href="#COMPorts">COM-ports</a></li>
<li><a href="#StatusLED">Status LED</a></li>
<li><a href="#Button">Programming Button</a></li>
<li><a href="#SofwareInstallation">Software Installation</a></li>
<li><a href="#Usage">Usage</a>
<ul>
<li><a href="#info">Info</a></li>
<li><a href="#chipInfo">Chip Info</a></li>
<li><a href="#chipSupport">Chip Support</a></li>
<li><a href="#chipLock">Chip Lock</a></li>
<li><a href="#chipUnlock">Chip Unlock</a></li>
<li><a href="#chipReboot">Chip Reboot</a></li>
<li><a href="#slotInfo">Slot info</a></li>
<li><a href="#slotStore">Slot store</a></li>
<li><a href="#slotReset">Slot reset</a></li>
<li><a href="#keyInfo">Key Info</a></li>
<li><a href="#keyStore">Key Store</a></li>
<li><a href="#keyReset">Key Reset</a></li>
<li><a href="#keyGen">Key Generate</a></li>
<li><a href="#update">Update</a></li>
<li><a href="#erasePage">Erase Page</a></li>
<li><a href="#eraseMass">Erase Mass</a></li>
<li><a href="#flashData">Flash Data</a></li>
<li><a href="#flashRead">Flash Read</a></li>
<li><a href="#flashFile">Flash File</a></li>
<li><a href="#flashProduct">Flash Product</a></li>
<li><a href="#configSpeed">Config Speed</a></li>
<li><a href="#lic">License</a></li>
<li><a href="#licCustom">License Custom</a></li>
<li><a href="#licCustomGen">License Custom Generate</a></li>
<li><a href="#fileInfo">File Info</a></li>
<li><a href="#fileSign">File Sign</a></li>
<li><a href="#fileExtract">File Extract</a></li>
<li><a href="#fileGenKey">File Generate Key</a></li>
<li><a href="#pinoutSet">Pinout Set</a></li>
<li><a href="#buttonInfo">Button Info</a></li>
<li><a href="#buttonSet">Button Set</a></li>
<li><a href="#rtcSet">RTC Set</a></li>
<li><a href="#logInfo">Log Info</a></li>
<li><a href="#logReset">Log Reset</a></li>
<li><a href="#presetInfo">Preset Info</a></li>
<li><a href="#presetSet">Preset Set</a></li>
<li><a href="#presetReset">Preset Reset</a></li>
<li><a href="#radioTest">Radio Test</a></li>
<li><a href="#radioSendPacked">Radio Send Packet</a></li>
<li><a href="#radioStop">Radio Stop</a></li>
<li><a href="#storageInfo">Storage Info</a></li>
</ul>
</li>
<li><a href="#Usecases">Use cases</a>
<ul>
<li><a href="#example_flash_file">Example flash a binary file</a></li>
<li><a href="#example_lic">Example load a licence <b>Z-Wave.Me</b></a></li>
<li><a href="#example_radio_test_programmer">Example radio tests</a></li>
</ul>
</li>
<li><a href="#TechnicalSpecifications">Technical specifications</a></li>
<li><a href="#Requirements">Requirements</a>
<li><a href="#Troubleshooting">Troubleshooting</a></li>
<li><a href="#Revision">Document revision</a></li>
<li><a href="#Channels">Channels and modulation</a></li>
</ul>
</nav>
</aside>
<header>
<div class="wrapper">
<div class="content">
<div class="menu">
<div class="hide-when-open hamburger" onclick="toggleMenu()"><div></div></div>
</div>
</div>
</div>
</header>
<div class="wrapper wrapper-helper">
<div class="content">
<h1 id="ProductDescription">Product description</h1>
<p>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.</b>
<center><img src="pics/Programmer-side.png" width="30%"></center>
<p>The Z-Wave.Me programmer can flash the following families of chips from Silicon Labs. For more detailed and accurate information, use <a href="#chipSupport">Chip support</a>:</p>
<ul>
<li>ZGM130S</li>
<li>ZGM230S</li>
<li>EFR32ZG23</li>
<li>MGM21</li>
<li>EFR32MG21</li>
<li>EFR32MG24</li>
</ul>
<p>The programmer can be used to manipulate the chip (<a href="#chipLock">lock</a>, <a href="#chipUnlock">unlock</a>, <a href="#chipReboot">reboot</a>), <a href="#flashFile">flash a file</a> or flash from the internal programmer storage (called <a href="#slotInfo">slot</a>).</p>
<h1 id="Package">Package</h1>
<p>The Z-Wave.Me Programmer package includes:</p>
<ul>
<li>Z-Wave.Me Programmer</li>
<li>2.4 GHz RP-SMA male antenna</li>
<li>868 MHz RP-SMA male antenna (for EU)</li>
<li>916 MHz RP-SMA male antenna (for US)</li>
<li>CR2032 coin-cell battery</li>
<li>Programming cable with IDC-10 female connector</li>
<li>USB-A to USB-C cable and USB-C to USB-C cable</li>
</ul>
<h1 id="Connecting">Connecting</h1>
<p>The front panel of the programmer has one programming port with IDC-10 male 10-pins (2x5) connector with pitch 2.54 mm.</p>
<center><img src="pics/Programmer-front-annotations.png" width="30%"></center>
<p>On the top panel there is a status LED and a programming button. You can configure how the button works using the command <a href="#buttonSet">Button set</a></p>
<p>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.</p>
<p>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.</p>
<center><img src="pics/Programmer-back-annotations.png" width="30%"></center>
<h1 id="Pinout">Programming port pinout</h1>
<p>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.</p>
<p>❗ 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 <a href="#configSpeed">Config speed</a><p>
<p>The programming port pinout configuration can be seen using the <a href="#Info_pinout">Pinout info</a> command and customized using the <a href="#pinoutSet">Pinout set</a> command. Default pinout is shown below:</p>
<figure>
<center>
<img src="pics/Programmer-port-pinout.svg" width="30%">
<figcaption><i>Programming port default pinout</i></figcaption>
</center>
</figure>
<p>Chip programming requires only SWDIO, SWCLK, RESET and GND. If power is not provided to the chip, VCC is also needed.</p>
<h1 id="COMPorts">COM-ports</h1>
<p>When connected through USB, the programmer provides 4 COM-ports (appears as ttyUSB0-4 on Linux). Ports of the programmer:</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Port</p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>ttyUSB0</p></td>
<td><p>Z-Wave controller</p></td>
</tr>
<tr>
<td><p>ttyUSB1</p></td>
<td><p>Z-Wave sniffer (PTI)</p></td>
</tr>
<tr>
<td><p>ttyUSB2</p></td>
<td><p>Programming interface and Zigbee controller</p></td>
</tr>
<tr id="COMPorts_pti_programmer">
<td><p>ttyUSB3</p></td>
<td><p>Zigbee sniffer (PTI)</p></td>
</tr>
</tbody>
</table>
<h1 id="StatusLED">Status LED</h1>
<p>The status LED shows the programmer current status and operation progress</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>LED status</p></th>
<th><p>Visualized<p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>Steady blue</p></td>
<td><p><font color="blue">●●●●</font></p></td>
<td><p>Ready</p></td>
</tr>
<tr>
<td><p>Steady orange</p></td>
<td><p><font color="orange">●●●●</font></p></td>
<td><p>Ready, but there are some problems with the hardware</p></td>
</tr>
<tr>
<td><p>Blinking green</p></td>
<td><p><font color="green">●</font>○<font color="green">●</font>○</p></td>
<td><p>Flahing in progress</p></td>
</tr>
<tr>
<td><p>Steady red</p></td>
<td><p><font color="red">●●●●</font></p></td>
<td><p>Error flashing</p></td>
</tr>
<tr>
<td><p>Blinking blue</p></td>
<td><p><font color="blue">●</font>○<font color="blue">●</font>○</p></td>
<td><p>Boot mode</p></td>
</tr>
<tr>
<td><p>Off</p></td>
<td><p>○○○○</p></td>
<td><p>Programmer is not powered</p></td>
</tr>
</tbody>
</table>
<h1 id="Button">Programming button</h1>
<p>You can configure the button action using the command <a href="#buttonSet">Button set</a></p>
<p>Create a preset with a command <a href="#presetSet">Preset set</a> and assigning it to the button <a href="#buttonSet">Button set</a> - this will allow you to initiate flashing using the button bypassing the terminal.</p>
<h1 id="SofwareInstallation">Z-Wave.Me software installation</h1>
<ul>
<li><a target="_blank" href="https://storage.z-wave.me/programmer-tool/files/zme_prog7/last/">Programmer Tool</a></li>
<li><a target="_blank" href="https://storage.z-wave.me/programmer-tool/files/zme_prog7/changelog.md">Programmer Tool Changelog</a></li>
<li><a target="_blank" href="https://storage.z-wave.me/programmer-tool/files/programmer/changelog.md">Programmer Firmware Changelog</a></li>
</ul>
<h1 id="Usage">Usage</h1>
<p>The programmer software has multiple functions.</p>
<p>Get the list of available commands:<br><code>zme_prog7 -h</code></p>
<p>Get specific parameters for each command:<br><code>zme_prog7 <command> -h</code></p>
<p>Common options for most commands:</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr id="Usage_device">
<td><p>-d --device</p></td>
<td><p>Device file (Unix) or COM-port (Windows)</p></td>
<td><p>/dev/ttyUSB2<br/>COM3</p></td>
</tr>
<tr id="Usage_baudrate">
<td><p>-b --baudrate</p></td>
<td><p>Baud rate - it is not necessary to indicate there is an auto search for the required speed</p></td>
<td><p>230400, 460800, 921600</p></td>
</tr>
</tbody>
</table>
<h3 id="info">Info</h3>
<p>Show programmer device information:<br><code>zme_prog7 info <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<figure>
<img src="pics/example_info.png">
<figcaption> <i>Typical output for info command</i></figcaption>
</figure>
The output is split in groups:
<table class="wikitable">
<tbody>
<tr>
<th><p>Group</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr id="Info_board">
<td><p>BOARD</p></td>
<td><p>General information about the programmer</p></td>
<td>
<table class="borderless">
<tr>
<td><b>UUID</b></td>
<td>Unique number of your programmer. You will need it for: <a href="#keyGen">Key generate</a> and <a href="#licCustomGen">License custom generate</a></td>
</tr>
</table>
</td>
</tr>
<tr id="Info_sn">
<td><p>SN</p></td>
<td><p>Serial number of the programmer</p></td>
<td></td>
</tr>
<tr id="Info_speed">
<td><p>SPEED</p></td>
<td><p>The current programmer interface speed settings, you can configure it using <a href="#configSpeed">Config speed</a></p></td>
<td>
<table class="borderless">
<tr>
<td><b>SAPI</b></td>
<td>
The speed at which <b>zme_prog7</b> communicates with the programmer firmware<br>
<b>zme_prog7</b> is capable of determining the speed itself, so it is not necessary to specify it explicitly using <b><a href="#Usage_baudrate">[-b --baudrate]</a></b>
</td>
</tr>
<tr>
<td><b>SWD</b></td>
<td>
The speed of interaction via the SWD protocol with the connected chip via IDC-10, including <a href="#chipInfo">Chip Info</a> and <a href="#flashFile">Flash File</a> commands
</td>
</tr>
<tr>
<td><b>SWD UART</b></td>
<td>
The flashing speed using <a href="#flashProduct">Flash product</a> command
</td>
</tr>
<tr>
<td><b>PTI</b></td>
<td>
The speed at which the radio will output data about received radio packets using PTI port
</td>
</tr>
</table>
</td>
</tr>
<tr id="Info_radio">
<td><p>RADIO</p></td>
<td><p>Shows of current radio status</p></td>
<td>
<table class="borderless">
<tr>
<td><b>MODE</b></td>
<td><b>IDLE</b> if the radio is not active, or the mode specified by the <a href="#radioTest_mode">Radio Test Mode</a> command</td>
</tr>
<tr>
<td><b>PROTOCOL</b></td>
<td>The current protocol specified using the <a href="#radioTest_freq">Radio Test Freq</a> command</td>
</tr>
<tr>
<td><b>CHANNEL</b></td>
<td>The current channel specified using the <a href="#radioTest_channel">Radio Test Channel</a> command</td>
</tr>
<tr>
<td><b>POWER</b></td>
<td>The current power specified using the <a href="#radioTest_power">Radio Test Power</a> command</td>
</tr>
</table>
</td>
</tr>
<tr id="Info_rtc">
<td><p>RTC</p></td>
<td><p>Shows information about the time configured using the <a href="#rtcSet">RTC set</a> command</p></td>
<td>
<table class="borderless">
<tr>
<td><b>UTC</b></td>
<td>The time of the programmer</td>
</tr>
<tr>
<td><b>LOCAL</b></td>
<td>The time of the programmer, taking into account your current zone</td>
</tr>
</table>
</td>
</tr>
<tr id="Info_pinout">
<td><p>PINOUT</p></td>
<td><p>Reflects the actual setting of your <b>IDC-10</b>. You can configure it using <a href="#pinoutSet">Pinout set</a></p></td>
<td>
<table class="borderless">
<tr>
<td><b>VCC</b></td>
<td>3V/+ - to power the connected chip</td>
</tr>
<tr>
<td><b>GND</b></td>
<td>Ground/0 - to power the connected chip</td>
</tr>
<tr>
<td><b>RESET</b></td>
<td>❗Allows you to perform a hard reset of the connected chip, necessary for correct work with chips via SWD</td>
</tr>
<tr>
<td><b>N/C</b></td>
<td>Disabled</td>
</tr>
<tr>
<td><b>N/A</b></td>
<td>Not available</td>
</tr>
<tr>
<td><b>BTN</b></td>
<td>Pin to connect an external button. You can assign actions to it using the command <a href="#buttonSet">Button set</a></td>
</tr>
<tr>
<td><b>SWDIO</b></td>
<td>❗Required for <b>SWD</b> to work</td>
</tr>
<tr>
<td><b>SWCLK</b></td>
<td>❗Required for <b>SWD</b> to work</td>
</tr>
</table>
</td>
</tr>
<tr id="Info_license_custom">
<td><p>LICENSE CUSTOM</p></td>
<td><p>Information about the permission to flash your firmware granted to the user (factory). You can install your license using the command <a href="#licCustom">License custom</a>, having previously generated using <a href="#licCustomGen">License custom generate</a></p></td>
<td>
<table class="borderless">
<tr>
<td><b>Flash counter</b></td>
<td>How many times have you already flashed the firmware</td>
</tr>
<tr>
<td><b>Flash counter max</b></td>
<td>How many times can you flash firmware</td>
</tr>
</table>
</td>
</tr>
<tr id="Info_license">
<td><p>LICENSE</p></td>
<td><p>Information about your permission to flash <b>Z-Wave.Me</b> firmwares. You can install this license using the command <a href="#lic">License</a></p></td>
<td>
<table class="borderless">
<tr>
<td><b>Flash counter</b></td>
<td>How many times have you already flashed the firmware from <b>Z-Wave.Me</b></td>
</tr>
<tr>
<td><b>Flash counter max</b></td>
<td>How many times can you flash firmware from <b>Z-Wave.Me</b></td>
</tr>
</table>
</td>
</tr>
</tbody>
</table>
<h3 id="chipInfo">Chip info</h3>
<p>Shows information about the chip connected via <b>SWD</b> to the programmer:<br><code>zme_prog7 chipInfo <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<figure>
<img src="pics/example_chip_info.png">
<figcaption> <i>Typical output of Chip Info command</i></figcaption>
</figure>
<h3 id="chipSupport">Chip support</h3>
<p>Displays the list of chips that you can work with. If you do not specify <code>[<a href="#Usage_device">-d --device</a>]</code> it will display chips supported by <code>zme_prog7</code>:<br><code>zme_prog7 chipSupport [<a href="#Usage_device">-d --device</a>] <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<figure>
<img src="pics/example_chip_support.png">
<figcaption> <i>Typical output of Chip Support command</i></figcaption>
</figure>
<h3 id="chipLock">Chip lock</h3>
<p>Lock the connected chip to prevent read-back of the firmware:<br><code>zme_prog7 chipLock <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>After locking the chip, the programmer will not be able to work with the chip anymore. To unlock the chip back, use: <a href="#chipUnlock">Chip unlock</a>. Unlocking will erase the existing firmware from the chip.</p>
<p>After locking the chip, if you use <a href="#chipInfo">Chip info</a>, you will see:</p>
<figure>
<img src="pics/example_chip_info_lock.png">
<figcaption> <i>Typical output of Chip Info for a locked chip</i></figcaption>
</figure>
<h3 id="chipUnlock">Chip unlock</h3>
<p>Unlock the connected device:<br><code>zme_prog7 chipUnlock <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>After this, the programmer will be able to fully work with the chip</p>
<p>❗This command will delete almost all chip data - be careful</p>
<h3 id="chipReboot">Chip reboot</h3>
<p>Reboot the connected device:<br><code>zme_prog7 chipReboot <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>Performs a hard reboot of the connected chip. For this action, the <b>RESET</b> pin is used. For more details check the <a href="#Pinout">Programming port pinout</a></p>
<h3 id="slotInfo">Slot info</h3>
<p>Prints available and occupied slots of the programmer:<br><code>zme_prog7 slotInfo <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>You can load into slots using <a href="#slotStore">Slot store</a>, reset their contents <a href="#slotReset">Slot reset</a></p>
<figure>
<img src="pics/example_slot_info.png">
<figcaption> <i>Typical output of Slot Info command</i></figcaption>
</figure>
<h3 id="slotStore">Slot store</h3>
<p>Loads signed image into a slot of the programmer:<br><code>zme_prog7 slotStore <filename> <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a> [-i --index]</code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>filename</p></td>
<td><p>Path to the <b>pkzme</b> file you want to load into the slot</a></p></td>
<td><p><b>pkzme</b> the file can be obtained from <b>Z-Wave.Me</b> or you can create it yourself using <a href="#fileSign">File sign</a></p></td>
<td><p>A zip file with multiple pkzme files can be used - in this case all, files will be loaded to available slots.</p></td>
</tr>
<tr>
<td><p>-i --index</p></td>
<td>
<p>Index of the slot where you want to load the <b>pkzme</b> file</p>
<p>If not specified, the first available index is used. If specified, the previous slot content will be overwritten. If there is not enough free space or no suitable keys to decrypt the image, it will give an error.</p>
<p>To install the key to successfully download <b>pkzme</b> use the command <a href="#keyStore">Key store</a></p>
</td>
<td><p>from 0 to 255</p></td>
</tr>
</tbody>
</table>
<h3 id="slotReset">Slot reset</h3>
<p>Clears slots previously written using the command <a href="#slotStore">Slot store</a>, You can see which slots are used <a href="#slotInfo">Slot info</a>:<br><code>zme_prog7 slotReset <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a> [-i --index]</code></p>
<p>❗Be careful all data is permanently deleted</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>-i --index</p></td>
<td>
<p>If are not specified have not specified, then all slots will be deleted, otherwise only the specified slot</p>
</td>
<td><p>from 0 to 255</p></td>
</tr>
</tbody>
</table>
<h3 id="keyInfo">Key info</h3>
<p>Shows all available keys:<br><code>zme_prog7 keyInfo <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>You can download the key using <a href="#keyStore">Key store</a>, or delete the command <a href="#keyReset">Key reset</a></p>
<figure>
<img src="pics/example_key_info.png">
<figcaption> <i>Typical Key Info output</i></figcaption>
</figure>
<h3 id="keyStore">Key store</h3>
<p>Loads keys into your programmer for loading <b>pkzme</b> files using the command <a href="#slotStore">Slot store</a>:<br><code>zme_prog7 keyStore <package> <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a> [-i --index]</code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>package</p></td>
<td>
<p>Key for loading into the <b>pkzme</b> programmer</p>
<p>The key can be obtained from <b>Z-Wave.Me</b> or you can generate it yourself using the command <a href="#keyGen">Key generate</a></p>
</td>
<td><p>hex string</p></td>
</tr>
<tr>
<td><p>-i --index</p></td>
<td>
<p>If not specified, it will be loaded into the first free slot</p>
<p>❗When overriding a key that is already in the slot with a new one, all <b>pkzme</b> files associated with this previous key will be deleted</p>
</td>
<td><p>from 0 to 15</p></td>
</tr>
</tbody>
</table>
<h3 id="keyReset">Key reset</h3>
<p>Removes keys:<br><code>zme_prog7 keyReset <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a> [-i --index]</code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>-i --index</p></td>
<td>
<p>If are not specified have not specified, all keys will be deleted</p>
<p>❗When deleting a key/keys, all <b>pkzme</b> files associated with this key/keys will be deleted</p>
</td>
<td><p>from 0 to 15</p></td>
</tr>
</tbody>
</table>
<h3 id="keyGen">Key generate</h3>
<p>Creates a <b>hex</b> string representing the key for <b>pkzme</b> signing:<br><code>zme_prog7 keyGen <uuid> -p --profile -k --key <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>uuid</p></td>
<td><p>The <a href="#Info_board">UUID</a> of your programmer</p></td>
<td><p>hex string</p></td>
</tr>
<tr>
<td><p>-p --profile</p></td>
<td>
<p>The key file that was used to create <b>pkzme</b> files</p>
<p>You can create it using the command <a href="#fileGenKey">File generate key</a></p>
</td>
<td><p></p></td>
</tr>
<tr>
<td><p>-k --key</p></td>
<td><p>Your personal key, which will be received with the license, is tied to your programmer</p></td>
<td><p>hex string</p></td>
</tr>
</tbody>
</table>
<h3 id="update">Update</h3>
<p>Checks for new version and, if necessary, update this software:<br><code>zme_prog7 update [-p --profile] <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>-p --profile</p></td>
<td>
<p>Pointer to a local file with update lists</p>
</td>
<td><p></p></td>
</tr>
</tbody>
</table>
<figure>
<img src="pics/example_update.png">
<figcaption> <i>Updating your programmer</i></figcaption>
</figure>
<h3 id="erasePage">Erase Page</h3>
<p>Erase area in the flash memory of the connected chip:<br><code>zme_prog7 erasePage -a --address -l --length <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>❗Data is permanently deleted</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>-a --address</p></td>
<td>
<p>The start address of the flash memory to be erased. It must be a multiple of the size of the flash page</p>
<p>You can find out the size of the flash page of the chip using the command <a href="#chipInfo">Chip info</a> - <b>Flash page size</b></p>
</td>
</tr>
<tr>
<td><p>-l --length</p></td>
<td>
<p>The size of the flash memory area you want to erase. It must be a multiple of the flash page size.</p>
<p>If the flash area itself is smaller than the size of the flash page, then you need to indicate the actual size</p>
<p>You can find out the size of the flash page of the chip using the command <a href="#chipInfo">Chip info</a> - <b>Flash page size</b></p>
</td>
</tr>
</tbody>
</table>
<h3 id="eraseMass">Erase Mass</h3>
<p>Erase the main flash memory of the connected chip:<br><code>zme_prog7 eraseMass <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>You can see the structure of flash memory using <a href="#chipInfo">Chip info</a> - This command will clear the memory <b>Flash address</b> and size <b>Flash size</b></p>
<p>❗Data is permanently deleted</p>
<h3 id="flashData">Flash Data</h3>
<p>Allows you to write data to the flash of the connected chip:<br><code>zme_prog7 flashData -a --address -da --data <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>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 <a href="#erasePage">Erase Page</a> or <a href="#eraseMass">Erase Mass</a></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>-a --address</p></td>
<td>
<p>Any valid address of the flash memory of the chip, you can see the available flash memory of the chip using <a href="#chipInfo">Chip info</a></p>
</td>
</tr>
<tr>
<td><p>-da --data</p></td>
<td>
<p>Valid <b>hex</b> data string. Does not exceed the available flash memory area</p>
</td>
</tr>
</tbody>
</table>
<h3 id="flashRead">Flash read</h3>
<p>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:<br><code>zme_prog7 flashRead -a --address -l --length <a href="#Usage_device">-d --device</a> [-o --outFile] <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>❗It is not possible to read flash memory if the chip was locked</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>-a --address</p></td>
<td>
<p>Any valid address of the flash memory of the chip, you can see the available flash memory of the chip using <a href="#chipInfo">Chip info</a></p>
</td>
</tr>
<tr>
<td><p>-l --length</p></td>
<td>
<p>The size of the memory you want to read, you can see the available flash memory of the chip using <a href="#chipInfo">Chip info</a></p>
</td>
</tr>
<tr>
<td><p>-o --outFile</p></td>
<td>
<p>Path to the file to which the read data will be saved. If not specified, it will be printed to the terminal</p>
<p>The data will be saved in binary form</p>
</td>
</tr>
</tbody>
</table>
<h3 id="flashFile">Flash file</h3>
<p>Write file content into the flash memory of the connected device:<br><code>zme_prog7 flashFile <filename> <a href="#Usage_device">-d --device</a> [-a --address] <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>Check <a href="#example_flash_file">examples of usage</a> for more info.</p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>filename</p></td>
<td>
<p>Flash a binary file in .bin or .hex format into the connected device</p>
<p>You can also flash the key generated earlier using the command <a href="#fileGenKey">File generate key</a></p>
</td>
</tr>
<tr>
<td><p>-a --address</p></td>
<td>
<p>Any valid address of the flash memory of the chip, you can see the available flash memory of the chip using <a href="#chipInfo">Chip info</a></p>
<p>This only needs to be specified for .bin files.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="flashProduct">Flash product</h3>
<p>Flashes the connected programmer using the firmware loaded into the programmer with the command <a href="#slotStore">Slot store</a>:<br><code>zme_prog7 flashProduct <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a> [-fi --firmwareIndex] [-bi --bootloaderIndex] [-ki --keyIndex] [-sei --seIndex] [-c --chip] [-u --userData] [-o --options] [-qr --qrCodeDir] [-dp --deviceProfile]</code></p>
<p>If the firmware downloaded by <a href="#slotStore">Slot store</a> was encrypted, then the number of times you can flash it is limited by the license </p>
<p>If you don’t explicitly specify all or some of the parameters, it will try to select it yourself</p>
<p>Logging is also carried out into external flash memory; you can view the contents of the log using the command <a href="#logInfo">Log info</a></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr id="flashProduct_firmwareIndex">
<td><p>-fi --firmwareIndex</p></td>
<td><p>Firmware slot index - the main firmware file</p></td>
<td><p>0 ... 255</p></td>
</tr>
<tr id="flashProduct_bootloaderIndex">
<td><p>-bi --bootloaderIndex</p></td>
<td><p>Bootloader slot index - a bootloader that allows to run and update the main firmware</p></td>
<td><p>0 ... 255</p></td>
</tr>
<tr id="flashProduct_seIndex">
<td><p>-sei --seIndex</p></td>
<td><p>Secure Engine slot index (required for some chips)</p></td>
<td><p>0 ... 255</p></td>
</tr>
<tr id="flashProduct_keyIndex">
<td><p>-ki --keyIndex</p></td>
<td><p>Key slot index</p></td>
<td><p>0 ... 255</p></td>
</tr>
<tr id="flashProduct_chip">
<td><p>-c --chip</p></td>
<td>
<p>Type of chip being flashed, you can see all supported chips using <a href="#chipSupport">Chip support</a></p>
</td>
<td><p></p></td>
</tr>
<tr id="flashProduct_options">
<td><p>-o --options</p></td>
<td><p>Additional options for customizing firmware</p></td>
<td>
<table class="borderless">
<tr>
<td><b>DSK</b></td>
<td>Let the programmer generate the Z-Wave DSK for the device (requires support in the firmware flashed)</td>
</tr>
<tr>
<td><b>NO_LOCK</b></td>
<td>Don't lock the chip after flashing. Works only if the firmware was loaded in the programmer unencrypted</td>
</tr>
</table>
</td>
</tr>
<tr id="flashProduct_userData">
<td><p>-u --userData</p></td>
<td><p>Defines custom user data as a hex-encoded string (requires support in the firmware flashed).</p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-qr --qrCodeDir</p></td>
<td><p>Output SmartStart QR-code dir (used in conjunction with <b>-o DSK</b>)</p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-dp --deviceProfile</p></td>
<td><p>Specifies product profile for the QR-code generation (only used in conjunction with <b>-o DSK</b>)</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<figure>
<img src="pics/example_flash_product.png">
<figcaption> <i>Flashing a device</i></figcaption>
</figure>
<h3 id="configSpeed">Config speed</h3>
<p>Set the communication speed with the programmer:<br><code>zme_prog7 configSpeed <a href="#Usage_device">-d --device</a> [-sapi --sapi] [-swd --swd] [-uart --uart] [-pti --pti] <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>-sapi --sapi</p></td>
<td>
<p><a href="#Info_speed">SAPI</a></p>
</td>
<td><p>230400, 460800 and 921600</p></td>
</tr>
<tr>
<td><p>-swd --swd</p></td>
<td>
<p><a href="#Info_speed">SWD</a></p>
<p>❗At high speeds, you need to pay attention to the length and the quality of the cable</p>
</td>
<td><p>1024000 to 19000000</p></td>
</tr>
<tr>
<td><p>-uart --uart</p></td>
<td>
<p><a href="#Info_speed">SWD UART</a></p>
<p>❗At high speeds, you need to pay attention to the length and the quality of the cable</p>
</td>
<td><p>960000 to 2500000</p></td>
</tr>
<tr>
<td><p>-pti --pti</p></td>
<td>
<p><a href="#Info_speed">PTI</a></p>
</td>
<td><p>230400, 460800 and 921600</p></td>
</tr>
</tbody>
</table>
<h3 id="lic">License</h3>
<p>Load a <b>Z-Wave.Me</b> license package in the programmer:<br><code>zme_prog7 lic <package> <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>You can see the current license status <a href="#Info_license">LICENSE</a></p>
<p>Check <a href="#example_lic">examples of using</a> for use cases</p>
<h3 id="licCustom">License custom</h3>
<p>Load a <b>custom</b> license package in the programmer:<br><code>zme_prog7 licCustom <package> <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>The package can be generated using the command <a href="#licCustomGen">License custom generate</a></p>
<p>You can see the current license status <a href="#Info_license_custom">LICENSE CUSTOM</a></p>
<h3 id="licCustomGen">License custom generate</h3>
<p>Generate a <b>custom</b> license package in the programmer:<br><code>zme_prog7 licCustomGen <uuid> <a href="#Usage_device">-d --device</a> <a href="#Usage_baudrate">[-b --baudrate]</a></code></p>
<p>You can see the current license status <a href="#Info_license_custom">LICENSE CUSTOM</a></p>
<p>You can install the newly generated license using the command <a href="#licCustom">License custom</a> </p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
</tr>
<tr>
<td><p>uuid</p></td>
<td><p>The <a href="#Info_board">UUID</a> of your programmer</p></td>
<td><p>hex string</p></td>
</tr>
<tr>
<td><p>-cm --countMax</p></td>
<td><p>Max programming counter</p></td>
<td><p>0 ... 4294967295</p></td>
<tr>
<td><p>-k --key</p></td>
<td><p>Your personal key, which will be received with the license, is tied to your programmer</p></td>
<td><p>hex string</p></td>
</tr>
</tr>
</tbody>
</table>
<h3 id="fileInfo">File info</h3>
<p>Show the <b>pkzme</b> file info:<br><code>zme_prog7 fileInfo <filename> <a href="#Usage_device">-d --device</a></code></p>
<p>Path to the <b>pkzme</b> file you want to get information about</p>
<p>You can create your own <b>pkzme</b> file using <a href="#fileSign">File sign</a> To do this, you will first need to create your key using <a href="#fileGenKey">File generate key</a></p>
<figure>
<img src="pics/example_flash_info.png">
<figcaption> <i>File Info command output</i></figcaption>
</figure>
<h3 id="fileSign">File sign</h3>
<p>Allows you to create a <b>pkzme</b> file from firmware (compiled using <b>SiLabs</b> SDK) using your created key <a href="#fileGenKey">File generate key</a>:<br><code>zme_prog7 fileSign <filename> -c --chip -obj --pkzmeObj <a href="#Usage_device">-d --device</a> [-o --output] [-p --profile] [-b --baseAddr] [-sv --seVersion]</code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
<th><p>Values</p></th>
<th><p>Default</p></th>
</tr>
<tr>
<td><p>filename</p></td>
<td>
Path to the file from which you want to make a <b>pkzme</b> file<br>
Supports <b>hex</b> or <b>bin</b> type files based on <b>SiLabs</b>
</td>
<td><p></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-c --chip</p></td>
<td>
<p>Type of chip being flashed, you can see all supported chips using <a href="#chipSupport">Chip support</a></p>
</td>
<td><p></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-obj --pkzmeObj</p></td>
<td><p>Property of the created <b>pkzme file</b> - regular firmware file <b>hex</b> or <b>bin</b> type <b>Silabs</b></p></td>
<td><p></p>BIN</td>
<td><p></p></td>
</tr>
<tr>
<td><p>-obj --pkzmeObj</p></td>
<td><p>Property of the created <b>pkzme file</b> - use encryption when creating, when specifying this parameter, you must specify the key via <b>-p --profile</b></p></td>
<td><p></p>AES</td>
<td><p></p></td>
</tr>
<tr>
<td><p>-obj --pkzmeObj</p></td>
<td><p>Property of the created <b>pkzme file</b> - compression is used to reduce the size and speed up stitching <b>lz4</b></p></td>
<td><p></p>LZ4</td>
<td><p></p></td>
</tr>
<tr>
<td><p>-o --output</p></td>
<td>
<p>Path with name to the output file</p>
</td>
<td><p></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-p --profile</p></td>
<td>
<p>Path to the key file created using the command <a href="#fileGenKey">File generate key</a> - a required parameter for <b>-obj AES</b></p>
</td>
<td><p></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-b --baseAddr</p></td>
<td>
<p>The base address where the firmware should be located on the chip is mandatory in the case of <b>bin</b> files</p>
</td>
<td><p></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p>-sv --seVersion</p></td>
<td>
<p>Minimum SE version with which the firmware can work</p>
</td>
<td><p></p></td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
<h3 id="fileExtract">File extract</h3>
<p>Allows you to unpack previously created <b>pkzme</b> files, <a href="#fileSign">File sign</a>:<br><code>zme_prog7 fileExtract <filename> <a href="#Usage_device">-d --device</a> [-o --output] [-p --profile]</code></p>
<table class="wikitable">
<tbody>
<tr>
<th><p>Option</p></th>
<th><p>Description</p></th>
</tr>
<tr>
<td><p>filename</p></td>
<td>