Skip to content

Commit ec9c57e

Browse files
authored
Add backup/restore to README (#17)
* Add backup/restore to README * Add a note about `--baudrate`
1 parent 549a3b9 commit ec9c57e

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,26 @@ Options:
2323
Commands:
2424
ota
2525
radio
26+
pcap
2627
```
2728

2829
# Network commands
2930
Network commands require the radio type to be specified. See `zigpy radio --help` for the list of supported types.
31+
If your radio requires a different baudrate than the radio library default (mainly EZSP), you must specify it as a command line option. For example, `zigpy radio --baudrate 115200 ezsp backup -`.
3032

31-
Reading network information:
33+
## Network backup
34+
35+
```console
36+
$ zigpy radio deconz /dev/ttyUSB0 network backup deconz-backup.json
37+
```
38+
39+
## Network restore
40+
41+
```console
42+
$ zigpy radio znp /dev/ttyUSB1 network restore deconz-backup.json
43+
```
44+
45+
## Reading network information
3246

3347
```console
3448
$ zigpy radio znp /dev/ttyUSB0 network info
@@ -43,7 +57,7 @@ Network key: cc:44:a6:4e:23:82:30:9e:35:0f:c6:6a:89:c8:dd:7d
4357
Network key sequence: 0
4458
```
4559

46-
Forming a network (with verbose logging enabled):
60+
## Forming a network
4761

4862
```console
4963
$ zigpy -vvvv radio znp /dev/cu.usb* form
@@ -67,10 +81,10 @@ Network key sequence: 0
6781
2021-07-12 13:25:15.316 host zigpy_znp.uart DEBUG Closing serial port
6882
```
6983

70-
Performing an energy scan (using a router device instead of the coordinator):
84+
## Performing an energy scan
7185

7286
```console
73-
$ zigpy radio znp /dev/cu.usbserial-1420 energy-scan --nwk 0xbc6a
87+
$ zigpy radio znp /dev/cu.usbserial-1420 energy-scan
7488

7589
Channel energy (mean of 1 / 5):
7690
------------------------------------------------
@@ -99,17 +113,17 @@ Channel energy (mean of 1 / 5):
99113
```
100114

101115
# OTA
102-
Display basic information about OTA files:
116+
## Display basic information about OTA files
103117
```console
104118
$ zigpy ota info 10047227-1.2-TRADFRI-cv-cct-unified-2.3.050.ota.ota.signed
105119
Header: OTAImageHeader(upgrade_file_id=200208670, header_version=256, header_length=56, field_control=<FieldControl.0: 0>, manufacturer_id=4476, image_type=16902, file_version=587531825, stack_version=2, header_string='GBL GBL_tradfri_cv_cct_unified', image_size=208766, *device_specific_file=False, *hardware_versions_present=False, *key=ImageKey(manufacturer_id=4476, image_type=16902), *security_credential_version_present=False)
106120
Number of subelements: 1
107121
Validation result: ValidationResult.VALID
108122
```
109123

110-
Dump embedded firmware for further analysis:
124+
## Dump embedded firmware for further analysis
111125

112-
```
126+
```console
113127
$ zigpy ota dump-firmware 10047227-1.2-TRADFRI-cv-cct-unified-2.3.050.ota.ota.signed - \
114128
| commander ebl print /dev/stdin \
115129
| grep 'Ember Version'
@@ -118,7 +132,9 @@ Ember Version: 6.3.1.1
118132

119133

120134
# PCAP
121-
Re-calculate the FCS on a packet capture due to a bug in current EmberZNet SDK releases:
135+
## Re-calculate the FCS on a packet capture
136+
137+
Fixes a bug in current EmberZNet SDK releases:
122138
```console
123139
$ # Fix an existing capture
124140
$ zigpy pcap fix-fcs input.pcap fixed.pcap

0 commit comments

Comments
 (0)