Skip to content

Commit c017696

Browse files
Pull request project-chip#1111: [DOC][Cherry-pick CSA]Silabs examples readme contained old paths.
Merge in WMN_TOOLS/matter from cp/doc_example_csa to RC_2.2.0-1.2 Squashed commit of the following: commit 964079f7a18b4336a611e8fcb92bfa683e4c02ea Author: Junior Martinez <67972863+jmartinez-silabs@users.noreply.github.com> Date: Mon Aug 28 11:04:05 2023 -0400 Silabs examples readme contained old paths. update them (project-chip#28900)
1 parent 48a3388 commit c017696

7 files changed

Lines changed: 73 additions & 76 deletions

File tree

examples/light-switch-app/silabs/README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Silicon Labs platform.
106106
* Build the example application:
107107

108108
cd ~/connectedhomeip
109-
./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32/ ./out/light-switch-app BRD4187C
109+
./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/ ./out/light-switch-app BRD4187C
110110

111111
- To delete generated executable, libraries and object files use:
112112

@@ -115,7 +115,7 @@ Silicon Labs platform.
115115

116116
OR use GN/Ninja directly
117117

118-
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
118+
$ cd ~/connectedhomeip/examples/light-switch-app/silabs
119119
$ git submodule update --init
120120
$ source third_party/connectedhomeip/scripts/activate.sh
121121
$ export SILABS_BOARD=BRD4187C
@@ -124,28 +124,28 @@ Silicon Labs platform.
124124

125125
- To delete generated executable, libraries and object files use:
126126

127-
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
127+
$ cd ~/connectedhomeip/examples/light-switch-app/silabs
128128
$ rm -rf out/
129129

130130
* Build the example with Matter shell
131131

132-
./scripts/examples/gn_silabs_example.sh examples/light-switch-app/silabs/efr32/ out/light-switch-app BRD4187C chip_build_libshell=true
132+
./scripts/examples/gn_silabs_example.sh examples/light-switch-app/silabs/ out/light-switch-app BRD4187C chip_build_libshell=true
133133

134134
* Build the example as Intermittently Connected Device (ICD)
135135

136-
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32/ ./out/light-switch-app_ICD BRD4187C --icd
136+
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/ ./out/light-switch-app_ICD BRD4187C --icd
137137

138138
or use gn as previously mentioned but adding the following arguments:
139139

140140
$ gn gen out/debug '--args=SILABS_BOARD="BRD4187C" enable_sleepy_device=true chip_openthread_ftd=false chip_build_libshell=true'
141141

142142
* Build the example with pigweed RCP
143143

144-
$ ./scripts/examples/gn_silabs_example.sh examples/light-switch-app/silabs/efr32/ out/light-switch-app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
144+
$ ./scripts/examples/gn_silabs_example.sh examples/light-switch-app/silabs/ out/light-switch-app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
145145

146146
or use GN/Ninja Directly
147147

148-
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
148+
$ cd ~/connectedhomeip/examples/light-switch-app/silabs
149149
$ git submodule update --init
150150
$ source third_party/connectedhomeip/scripts/activate.sh
151151
$ export SILABS_BOARD=BRD4187C
@@ -161,7 +161,7 @@ arguments
161161

162162
- On the command line:
163163

164-
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
164+
$ cd ~/connectedhomeip/examples/light-switch-app/silabs
165165
$ python3 out/debug/matter-silabs-light-switch-example.flash.py
166166

167167
- Or with the Ozone debugger, just load the .out file.
@@ -173,7 +173,6 @@ Releases page on
173173

174174
- On the command line:
175175

176-
177176
$ commander flash bootloader_binaries/bootloader-storage-internal-single-512k-BRD4187C-gsdk4.1.s37
178177

179178
## Viewing Logging Output
@@ -216,12 +215,10 @@ combination with JLinkRTTClient as follows:
216215

217216
$ JLinkExe -device EFR32MG12PXXXF1024 -if JTAG -speed 4000 -autoconnect 1
218217

219-
220218
For MG21 use:
221219

222220
$ JLinkExe -device EFR32MG21AXXXF1024 -if SWD -speed 4000 -autoconnect 1
223221

224-
225222
For MG24 use:
226223

227224
$ JLinkExe -device EFR32MG24AXXXF1536 -if SWD -speed 4000 -autoconnect 1
@@ -402,7 +399,7 @@ To track memory usage you can set `enable_heap_monitoring = true` either in the
402399
BUILD.gn file or pass it as a build argument to gn. This will print on the RTT
403400
console the RAM usage of each individual task and the number of Memory
404401
allocation and Free. While this is not extensive monitoring you're welcome to
405-
modify `examples/platform/silabs/efr32/MemMonitoring.cpp` to add your own memory
402+
modify `examples/platform/silabs/MemMonitoring.cpp` to add your own memory
406403
tracking code inside the `trackAlloc` and `trackFree` function
407404
408405
## OTA Software Update
@@ -421,19 +418,19 @@ features can easily be toggled on or off. Here is a short list of options :
421418
422419
chip_progress_logging, chip_detail_logging, chip_automation_logging
423420
424-
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
421+
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs ./out/light-switch-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
425422
426423
### Debug build / release build
427424
428425
is_debug
429426
430-
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A "is_debug=false"
427+
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs ./out/light-switch-app BRD4164A "is_debug=false"
431428
432429
### Disabling LCD
433430
434431
show_qr_code
435432
436-
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A "show_qr_code=false"
433+
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs ./out/light-switch-app BRD4164A "show_qr_code=false"
437434
438435
### KVS maximum entry count
439436
@@ -442,4 +439,4 @@ kvs_max_entries
442439
Set the maximum Kvs entries that can be stored in NVM (Default 75)
443440
Thresholds: 30 <= kvs_max_entries <= 255
444441
445-
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A kvs_max_entries=50
442+
$ ./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs ./out/light-switch-app BRD4164A kvs_max_entries=50

examples/lighting-app/silabs/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Silicon Labs platform.
102102
* Build the example application:
103103

104104
cd ~/connectedhomeip
105-
./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/efr32/ ./out/lighting-app BRD4187C
105+
./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/ ./out/lighting-app BRD4187C
106106

107107
- To delete generated executable, libraries and object files use:
108108

@@ -111,7 +111,7 @@ Silicon Labs platform.
111111

112112
OR use GN/Ninja directly
113113

114-
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
114+
$ cd ~/connectedhomeip/examples/lighting-app/silabs
115115
$ git submodule update --init
116116
$ source third_party/connectedhomeip/scripts/activate.sh
117117
$ export SILABS_BOARD=BRD4187C
@@ -120,24 +120,24 @@ Silicon Labs platform.
120120

121121
- To delete generated executable, libraries and object files use:
122122

123-
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
123+
$ cd ~/connectedhomeip/examples/lighting-app/silabs
124124
$ rm -rf out/
125125

126126
* Build the example as Intermittently Connected Device (ICD)
127127

128-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/efr32/ ./out/lighting-app_ICD BRD4187C --icd
128+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/ ./out/lighting-app_ICD BRD4187C --icd
129129

130130
or use gn as previously mentioned but adding the following arguments:
131131

132132
$ gn gen out/debug '--args=SILABS_BOARD="BRD4187C" enable_sleepy_device=true chip_openthread_ftd=false'
133133

134134
* Build the example with pigweed RPC
135135

136-
$ ./scripts/examples/gn_silabs_example.sh examples/lighting-app/silabs/efr32/ out/lighting_app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
136+
$ ./scripts/examples/gn_silabs_example.sh examples/lighting-app/silabs/ out/lighting_app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
137137

138138
or use GN/Ninja Directly
139139

140-
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
140+
$ cd ~/connectedhomeip/examples/lighting-app/silabs
141141
$ git submodule update --init
142142
$ source third_party/connectedhomeip/scripts/activate.sh
143143
$ export SILABS_BOARD=BRD4187C
@@ -155,7 +155,7 @@ arguments
155155

156156
- On the command line:
157157

158-
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
158+
$ cd ~/connectedhomeip/examples/lighting-app/silabs
159159
$ python3 out/debug/matter-silabs-lighting-example.flash.py
160160

161161
- Or with the Ozone debugger, just load the .out file.
@@ -341,7 +341,7 @@ To track memory usage you can set `enable_heap_monitoring = true` either in the
341341
BUILD.gn file or pass it as a build argument to gn. This will print on the RTT
342342
console the RAM usage of each individual task and the number of Memory
343343
allocation and Free. While this is not extensive monitoring you're welcome to
344-
modify `examples/platform/silabs/efr32/MemMonitoring.cpp` to add your own memory
344+
modify `examples/platform/silabs/MemMonitoring.cpp` to add your own memory
345345
tracking code inside the `trackAlloc` and `trackFree` function
346346

347347
## OTA Software Update
@@ -369,19 +369,19 @@ passed to the build scripts.
369369

370370
`chip_progress_logging, chip_detail_logging, chip_automation_logging`
371371

372-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/efr32 ./out/lighting-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
372+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs ./out/lighting-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
373373

374374
### Debug build / release build
375375

376376
`is_debug`
377377

378-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/efr32 ./out/lighting-app BRD4164A "is_debug=false"
378+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs ./out/lighting-app BRD4164A "is_debug=false"
379379

380380
### Disabling LCD
381381

382382
`show_qr_code`
383383

384-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/efr32 ./out/lighting-app BRD4164A "show_qr_code=false"
384+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs ./out/lighting-app BRD4164A "show_qr_code=false"
385385

386386
### KVS maximum entry count
387387

@@ -390,4 +390,4 @@ passed to the build scripts.
390390
Set the maximum Kvs entries that can be stored in NVM (Default 75)
391391
Thresholds: 30 <= kvs_max_entries <= 255
392392

393-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs/efr32 ./out/lighting-app BRD4164A kvs_max_entries=50
393+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lighting-app/silabs ./out/lighting-app BRD4164A kvs_max_entries=50

examples/lock-app/silabs/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Mac OS X
102102

103103
```
104104
cd ~/connectedhomeip
105-
./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/efr32/ ./out/lock_app BRD4187C
105+
./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/ ./out/lock_app BRD4187C
106106
```
107107

108108
- To delete generated executable, libraries and object files use:
@@ -115,7 +115,7 @@ Mac OS X
115115
OR use GN/Ninja directly
116116

117117
```
118-
$ cd ~/connectedhomeip/examples/silabs/lock-app/efr32
118+
$ cd ~/connectedhomeip/examples/lock-app/silabs/
119119
$ git submodule update --init
120120
$ source third_party/connectedhomeip/scripts/activate.sh
121121
$ export SILABS_BOARD=BRD4187C
@@ -126,14 +126,14 @@ Mac OS X
126126
- To delete generated executable, libraries and object files use:
127127

128128
```
129-
$ cd ~/connectedhomeip/examples/lock-app/silabs/efr32
129+
$ cd ~/connectedhomeip/examples/lock-app/silabs
130130
$ rm -rf out/
131131
```
132132

133133
* Build the example as Intermittently Connected Device (ICD)
134134

135135
```
136-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/efr32/ ./out/lock-app_ICD BRD4187C --icd
136+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/ ./out/lock-app_ICD BRD4187C --icd
137137
```
138138

139139
or use gn as previously mentioned but adding the following arguments:
@@ -145,13 +145,13 @@ Mac OS X
145145
* Build the example with pigweed RCP
146146

147147
```
148-
$ ./scripts/examples/gn_silabs_example.sh examples/lock-app/silabs/efr32/ out/lock_app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
148+
$ ./scripts/examples/gn_silabs_example.sh examples/lock-app/silabs/ out/lock_app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
149149
```
150150

151151
or use GN/Ninja Directly
152152

153153
```
154-
$ cd ~/connectedhomeip/examples/lock-app/silabs/efr32
154+
$ cd ~/connectedhomeip/examples/lock-app/silabs
155155
$ git submodule update --init
156156
$ source third_party/connectedhomeip/scripts/activate.sh
157157
$ export SILABS_BOARD=BRD4187C
@@ -171,7 +171,7 @@ arguments
171171
- On the command line:
172172

173173
```
174-
$ cd ~/connectedhomeip/examples/lock-app/silabs/efr32
174+
$ cd ~/connectedhomeip/examples/lock-app/silabs
175175
$ python3 out/debug/matter-silabs-lock-example.flash.py
176176
```
177177

@@ -373,7 +373,7 @@ To track memory usage you can set `enable_heap_monitoring = true` either in the
373373
BUILD.gn file or pass it as a build argument to gn. This will print on the RTT
374374
console the RAM usage of each individual task and the number of Memory
375375
allocation and Free. While this is not extensive monitoring you're welcome to
376-
modify `examples/platform/silabs/efr32/MemMonitoring.cpp` to add your own memory
376+
modify `examples/platform/silabs/MemMonitoring.cpp` to add your own memory
377377
tracking code inside the `trackAlloc` and `trackFree` function
378378

379379
## OTA Software Update
@@ -393,23 +393,23 @@ features can easily be toggled on or off. Here is a short list of options :
393393
`chip_progress_logging, chip_detail_logging, chip_automation_logging`
394394

395395
```
396-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
396+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs ./out/lock-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
397397
```
398398

399399
### Debug build / release build
400400

401401
`is_debug`
402402

403403
```
404-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A "is_debug=false"
404+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs ./out/lock-app BRD4164A "is_debug=false"
405405
```
406406

407407
### Disabling LCD
408408

409409
`show_qr_code`
410410

411411
```
412-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A "show_qr_code=false"
412+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs ./out/lock-app BRD4164A "show_qr_code=false"
413413
```
414414

415415
### KVS maximum entry count
@@ -420,5 +420,5 @@ features can easily be toggled on or off. Here is a short list of options :
420420
Set the maximum Kvs entries that can be stored in NVM (Default 75)
421421
Thresholds: 30 <= kvs_max_entries <= 255
422422

423-
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A kvs_max_entries=50
423+
$ ./scripts/examples/gn_silabs_example.sh ./examples/lock-app/silabs ./out/lock-app BRD4164A kvs_max_entries=50
424424
```

0 commit comments

Comments
 (0)