Skip to content

Commit

Permalink
[Silabs] EFR32 documentation update due to folder reorg (#24452)
Browse files Browse the repository at this point in the history
* EFR32 documentation update due to folder reorg

* Restyling the PR
  • Loading branch information
chirag-silabs authored and pull[bot] committed Jul 20, 2023
1 parent 0097260 commit 1261968
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 59 deletions.
28 changes: 14 additions & 14 deletions examples/light-switch-app/silabs/efr32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Silicon Labs platform.
* Build the example application:

cd ~/connectedhomeip
./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/efr32/ ./out/light-switch-app BRD4161A
./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/silabs/efr32/ ./out/light-switch-app BRD4161A

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

Expand All @@ -140,7 +140,7 @@ Silicon Labs platform.

OR use GN/Ninja directly

$ cd ~/connectedhomeip/examples/light-switch-app/efr32
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export EFR32_BOARD=BRD4161A
Expand All @@ -149,28 +149,28 @@ Silicon Labs platform.

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

$ cd ~/connectedhomeip/examples/light-switch-app/efr32
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
$ rm -rf out/

* Build the example with Matter shell

./scripts/examples/gn_efr32_example.sh examples/light-switch-app/efr32/ out/light-switch-app BRD4161A chip_build_libshell=true
./scripts/examples/gn_efr32_example.sh examples/light-switch-app/silabs/efr32/ out/light-switch-app BRD4161A chip_build_libshell=true

* Build the example as Sleepy End Device (SED)

$ ./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/efr32/ ./out/light-switch-app_SED BRD4161A --sed
$ ./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/silabs/efr32/ ./out/light-switch-app_SED BRD4161A --sed

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

$ gn gen out/debug '--args=silabs_board="BRD4161A" enable_sleepy_device=true chip_openthread_ftd=false chip_build_libshell=true'

* Build the example with pigweed RCP

$ ./scripts/examples/gn_efr32_example.sh examples/light-switch-app/efr32/ out/light-switch-app_rpc BRD4161A 'import("//with_pw_rpc.gni")'
$ ./scripts/examples/gn_efr32_example.sh examples/light-switch-app/silabs/efr32/ out/light-switch-app_rpc BRD4161A 'import("//with_pw_rpc.gni")'

or use GN/Ninja Directly

$ cd ~/connectedhomeip/examples/light-switch-app/efr32
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export EFR32_BOARD=BRD4161A
Expand All @@ -186,7 +186,7 @@ arguments

- On the command line:

$ cd ~/connectedhomeip/examples/lighting-app/efr32
$ cd ~/connectedhomeip/examples/light-switch-app/silabs/efr32
$ python3 out/debug/chip-efr32-light-switch-example.flash.py

- Or with the Ozone debugger, just load the .out file.
Expand Down Expand Up @@ -252,7 +252,7 @@ combination with JLinkRTTClient as follows:

- For this example to work, it is necessary to have a second efr32 device
running the
[lighting app example](https://github.com/project-chip/connectedhomeip/blob/master/examples/lighting-app/efr32/README.md)
[lighting app example](https://github.com/project-chip/connectedhomeip/blob/master/examples/lighting-app/silabs/efr32/README.md)
commissioned on the same openthread network

- User interface : **LCD** The LCD on Silabs WSTK shows a QR Code. This QR
Expand Down Expand Up @@ -411,7 +411,7 @@ To track memory usage you can set `enable_heap_monitoring = true` either in the
BUILD.gn file or pass it as a build argument to gn. This will print on the RTT
console the RAM usage of each individual task and the number of Memory
allocation and Free. While this is not extensive monitoring you're welcome to
modify `examples/platform/efr32/MemMonitoring.cpp` to add your own memory
modify `examples/platform/silabs/efr32/MemMonitoring.cpp` to add your own memory
tracking code inside the `trackAlloc` and `trackFree` function
## OTA Software Update
Expand All @@ -430,19 +430,19 @@ features can easily be toggled on or off. Here is a short list of options :
chip_progress_logging, chip_detail_logging, chip_automation_logging
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
$ ./scripts/examples/gn_efr32_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"
### Debug build / release build
is_debug
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A "is_debug=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A "is_debug=false"
### Disabling LCD
show_qr_code
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A "show_qr_code=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A "show_qr_code=false"
### KVS maximum entry count
Expand All @@ -451,4 +451,4 @@ kvs_max_entries
Set the maximum Kvs entries that can be stored in NVM (Default 75)
Thresholds: 30 <= kvs_max_entries <= 255
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A kvs_max_entries=50
$ ./scripts/examples/gn_efr32_example.sh ./examples/light-switch-app/silabs/efr32 ./out/light-switch-app BRD4164A kvs_max_entries=50
12 changes: 6 additions & 6 deletions examples/lighting-app/silabs/efr32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Silicon Labs platform.

OR use GN/Ninja directly

$ cd ~/connectedhomeip/examples/lighting-app/efr32
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export silabs_board=BRD4161A
Expand All @@ -143,7 +143,7 @@ Silicon Labs platform.

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

$ cd ~/connectedhomeip/examples/lighting-app/efr32
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
$ rm -rf out/

* Build the example as Sleepy End Device (SED)
Expand All @@ -156,11 +156,11 @@ Silicon Labs platform.

* Build the example with pigweed RPC

$ ./scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32/ out/lighting_app_rpc BRD4161A 'import("//with_pw_rpc.gni")'
$ ./scripts/examples/gn_efr32_example.sh examples/lighting-app/silabs/efr32/ out/lighting_app_rpc BRD4161A 'import("//with_pw_rpc.gni")'

or use GN/Ninja Directly

$ cd ~/connectedhomeip/examples/lighting-app/efr32
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export silabs_board=BRD4161A
Expand All @@ -178,7 +178,7 @@ arguments

- On the command line:

$ cd ~/connectedhomeip/examples/lighting-app/efr32
$ cd ~/connectedhomeip/examples/lighting-app/silabs/efr32
$ python3 out/debug/chip-efr32-lighting-example.flash.py

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

## OTA Software Update
Expand Down
30 changes: 15 additions & 15 deletions examples/lock-app/silabs/efr32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ If the LCD is enabled, the LCD on the Silabs WSTK shows a QR Code containing the
needed commissioning information for the BLE connection and starting the
Rendez-vous procedure.

The lighting example is intended to serve both as a means to explore the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.
The lock example is intended to serve both as a means to explore the workings of
Matter as well as a template for creating real products based on the Silicon
Labs platform.

## Building

Expand Down Expand Up @@ -128,7 +128,7 @@ Mac OS X

```
cd ~/connectedhomeip
./scripts/examples/gn_efr32_example.sh ./examples/lock-app/efr32/ ./out/lock_app BRD4161A
./scripts/examples/gn_efr32_example.sh ./examples/lock-app/silabs/efr32/ ./out/lock_app BRD4161A
```

- To delete generated executable, libraries and object files use:
Expand All @@ -141,7 +141,7 @@ Mac OS X
OR use GN/Ninja directly

```
$ cd ~/connectedhomeip/examples/lock-app/efr32
$ cd ~/connectedhomeip/examples/silabs/lock-app/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export EFR32_BOARD=BRD4161A
Expand All @@ -152,14 +152,14 @@ Mac OS X
- To delete generated executable, libraries and object files use:

```
$ cd ~/connectedhomeip/examples/lock-app/efr32
$ cd ~/connectedhomeip/examples/lock-app/silabs/efr32
$ rm -rf out/
```

* Build the example as Sleepy End Device (SED)

```
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32/ ./out/lighting-app_SED BRD4161A --sed
$ ./scripts/examples/gn_efr32_example.sh ./examples/lock-app/silabs/efr32/ ./out/lock-app_SED BRD4161A --sed
```

or use gn as previously mentioned but adding the following arguments:
Expand All @@ -171,13 +171,13 @@ Mac OS X
* Build the example with pigweed RCP

```
$ ./scripts/examples/gn_efr32_example.sh examples/lock-app/efr32/ out/lock_app_rpc BRD4161A 'import("//with_pw_rpc.gni")'
$ ./scripts/examples/gn_efr32_example.sh examples/lock-app/silabs/efr32/ out/lock_app_rpc BRD4161A 'import("//with_pw_rpc.gni")'
```

or use GN/Ninja Directly

```
$ cd ~/connectedhomeip/examples/lock-app/efr32
$ cd ~/connectedhomeip/examples/lock-app/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export EFR32_BOARD=BRD4161A
Expand All @@ -197,7 +197,7 @@ arguments
- On the command line:

```
$ cd ~/connectedhomeip/examples/lock-app/efr32
$ cd ~/connectedhomeip/examples/lock-app/silabs/efr32
$ python3 out/debug/chip-efr32-lock-example.flash.py
```

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

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

```
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
```

### Debug build / release build

`is_debug`

```
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A "is_debug=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A "is_debug=false"
```

### Disabling LCD

`show_qr_code`

```
$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A "show_qr_code=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A "show_qr_code=false"
```

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

$ ./scripts/examples/gn_efr32_example.sh ./examples/lighting-app/efr32 ./out/lighting-app BRD4164A kvs_max_entries=50
$ ./scripts/examples/gn_efr32_example.sh ./examples/lock-app/silabs/efr32 ./out/lock-app BRD4164A kvs_max_entries=50
```
26 changes: 13 additions & 13 deletions examples/thermostat/silabs/efr32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Silicon Labs platform.
* Build the example application:

cd ~/connectedhomeip
./scripts/examples/gn_efr32_example.sh ./examples/thermostat/efr32/ ./out/thermostat-app BRD4161A
./scripts/examples/gn_efr32_example.sh ./examples/thermostat/silabs/efr32/ ./out/thermostat-app BRD4161A

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

Expand All @@ -140,7 +140,7 @@ Silicon Labs platform.

OR use GN/Ninja directly

$ cd ~/connectedhomeip/examples/thermostat/efr32
$ cd ~/connectedhomeip/examples/thermostat/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export EFR32_BOARD=BRD4161A
Expand All @@ -149,28 +149,28 @@ Silicon Labs platform.

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

$ cd ~/connectedhomeip/examples/thermostat/efr32
$ cd ~/connectedhomeip/examples/thermostat/silabs/efr32
$ rm -rf out/

* Build the example with Matter shell

./scripts/examples/gn_efr32_example.sh examples/thermostat/efr32/ out/thermostat-app BRD4161A chip_build_libshell=true
./scripts/examples/gn_efr32_example.sh examples/thermostat/silabs/efr32/ out/thermostat-app BRD4161A chip_build_libshell=true

* Build the example as Sleepy End Device (SED)

$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/efr32/ ./out/thermostat-app_SED BRD4161A --sed
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/silabs/efr32/ ./out/thermostat-app_SED BRD4161A --sed

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

$ gn gen out/debug '--args=silabs_board="BRD4161A" enable_sleepy_device=true chip_openthread_ftd=false chip_build_libshell=true'

* Build the example with pigweed RCP

$ ./scripts/examples/gn_efr32_example.sh examples/thermostat/efr32/ out/thermostat-app_rpc BRD4161A 'import("//with_pw_rpc.gni")'
$ ./scripts/examples/gn_efr32_example.sh examples/thermostat/silabs/efr32/ out/thermostat-app_rpc BRD4161A 'import("//with_pw_rpc.gni")'

or use GN/Ninja Directly

$ cd ~/connectedhomeip/examples/thermostat/efr32
$ cd ~/connectedhomeip/examples/thermostat/silabs/efr32
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ export EFR32_BOARD=BRD4161A
Expand All @@ -186,7 +186,7 @@ arguments

- On the command line:

$ cd ~/connectedhomeip/examples/thermostat/efr32
$ cd ~/connectedhomeip/examples/thermostat/silabs/efr32
$ python3 out/debug/chip-efr32-thermostat-switch-example.flash.py

- Or with the Ozone debugger, just load the .out file.
Expand Down Expand Up @@ -252,7 +252,7 @@ combination with JLinkRTTClient as follows:

- For this example to work, it is necessary to have a second efr32 device
running the
[thermostat app example](https://github.com/project-chip/connectedhomeip/blob/master/examples/thermostat/efr32/README.md)
[thermostat app example](https://github.com/project-chip/connectedhomeip/blob/master/examples/thermostat/silabs/efr32/README.md)
commissioned on the same openthread network

- User interface : **LCD** The LCD on Silabs WSTK shows a QR Code. This QR
Expand Down Expand Up @@ -373,19 +373,19 @@ features can easily be toggled on or off. Here is a short list of options :
chip_progress_logging, chip_detail_logging, chip_automation_logging
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/efr32 ./out/thermostat-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/silabs/efr32 ./out/thermostat-app BRD4164A "chip_detail_logging=false chip_automation_logging=false chip_progress_logging=false"
### Debug build / release build
is_debug
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/efr32 ./out/thermostat-app BRD4164A "is_debug=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/silabs/efr32 ./out/thermostat-app BRD4164A "is_debug=false"
### Disabling LCD
show_qr_code
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/efr32 ./out/thermostat-app BRD4164A "show_qr_code=false"
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/silabs/efr32 ./out/thermostat-app BRD4164A "show_qr_code=false"
### KVS maximum entry count
Expand All @@ -394,4 +394,4 @@ kvs_max_entries
Set the maximum Kvs entries that can be stored in NVM (Default 75)
Thresholds: 30 <= kvs_max_entries <= 255
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/efr32 ./out/thermostat-app BRD4164A kvs_max_entries=50
$ ./scripts/examples/gn_efr32_example.sh ./examples/thermostat/silabs/efr32 ./out/thermostat-app BRD4164A kvs_max_entries=50
Loading

0 comments on commit 1261968

Please sign in to comment.