Skip to content

Commit

Permalink
WiSeConnect release: 2.4.1. Examples & Documentation Update #1.
Browse files Browse the repository at this point in the history
  • Loading branch information
wifi-ci-agent committed Sep 3, 2021
1 parent 489e2e8 commit 78d7cd2
Show file tree
Hide file tree
Showing 26 changed files with 225 additions and 206 deletions.
4 changes: 2 additions & 2 deletions examples/snippets/ble/ble_multiconnection_gatt_test/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ The Application is provided with the project folder containing Keil and Simplici

### 3.4 RTOS Support

This application supports only RTOS configuration. By default, the application project files (Keil and Simplicity studio) are provided with OS environment in the release package.
This application supports only RTOS configuration. By default, the application project files (Keil and Simplicity studio) are provided with OS environment in the SDK.

## 4. Application Configuration Parameters

The application can be configured to suit your requirements and development environment. Read through the following sections and make any changes needed.

**4.1** open `rsi_ble_config.h` file provided in the release package at `examples/snippets/ble/ble_multiconnection_gatt_test` update/modify following macros.
**4.1** open `rsi_ble_config.h` file provided in the SDK at `examples/snippets/ble/ble_multiconnection_gatt_test` update/modify following macros.

**4.1.1** User must update the below parameters

Expand Down
2 changes: 1 addition & 1 deletion examples/snippets/bt/bt_a2dp_source_with_avrcp/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The Application is provided with the project folder containing IAR project files

### 3.4 RTOS Support

This application supports only RTOS environment. By default, the application project files **IAR IDE** are provided with OS configuration in the release package.
This application supports only RTOS environment. By default, the application project files **IAR IDE** are provided with OS configuration in the SDK.


## 4. Application Configuration Parameters
Expand Down
14 changes: 7 additions & 7 deletions examples/snippets/wlan/access_point/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,21 @@ The Application is provided with the project folder containing Keil and Simplici

* Keil Project
- The Keil project is used to evaluate the application on STM32.
- Project path: `<Release_Package>/examples/snippets/wlan/access_point/projects/access_point-nucleo-f411re.uvprojx`
- Project path: `<SDK>/examples/snippets/wlan/access_point/projects/access_point-nucleo-f411re.uvprojx`

* Simplicity Studio
- The Simplicity Studio project is used to evaluate the application on EFR32MG21.
- Project path:
- If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<Release_Package>/examples/snippets/wlan/access_point/projects/access_point-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<Release_Package>/examples/snippets/wlan/access_point/projects/access_point-brd4180b-mg21.slsproj`
- If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<SDK>/examples/snippets/wlan/access_point/projects/access_point-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<SDK>/examples/snippets/wlan/access_point/projects/access_point-brd4180b-mg21.slsproj`
- User can find the Radio Board version as given below

![EFR Radio Boards](resources/readme/image83a.png)


### 3.4 Bare Metal Support

This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the release package.
This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the SDK.

## 4. Application Configuration Parameters

Expand Down Expand Up @@ -198,7 +198,7 @@ User has to follow the below steps for the successful execution of the applicati

### 5.1 Loading the RS9116W Firmware

Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK. The firmware file is located in `<Release_Package>/firmware/`
Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK. The firmware file is located in `<SDK>/firmware/`


### 5.2 Building the Application on Host Platform
Expand All @@ -207,7 +207,7 @@ Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconn

Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-stm32/)

- Open the project `<Release_Package>/examples/snippets/wlan/access_point/projects/access_point-nucleo-f411re.uvprojx`
- Open the project `<SDK>/examples/snippets/wlan/access_point/projects/access_point-nucleo-f411re.uvprojx`
- Build and Debug the project
- Check for the RESET pin:
- If RESET pin is connected from STM32 to RS9116W EVK, then user need not press the RESET button on RS9116W EVK before free run.
Expand All @@ -219,7 +219,7 @@ Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/la

Refer [Getting started with EFX32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-efx32/)

- Open Simplicity Studio and import the project from `<Release_Package>/examples/snippets/wlan/access_point/projects`
- Open Simplicity Studio and import the project from `<SDK>/examples/snippets/wlan/access_point/projects`
- Select the appropriate .slsproj as per the Radio Board type mentioned in **Section 3.3**
- Compile and flash the project in to Host MCU
- Debug the project
Expand Down
14 changes: 7 additions & 7 deletions examples/snippets/wlan/calibration_app/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,21 +55,21 @@ The Application is provided with the project folder containing Keil and Simplici

* Keil Project
- The Keil project is used to evaluate the application on STM32.
- Project path: `<Release_Package>/examples/snippets/wlan/calibration_app/projects/calibration_app-nucleo-f411re.uvprojx`
- Project path: `<SDK>/examples/snippets/wlan/calibration_app/projects/calibration_app-nucleo-f411re.uvprojx`

* Simplicity Studio
- The Simplicity Studio project is used to evaluate the application on EFR32MG21.
- Project path:
- If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<Release_Package>/examples/snippets/wlan/calibration_app/projects/calibration_app-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<Release_Package>/examples/snippets/wlan/calibration_app/projects/calibration_app-brd4180b-mg21.slsproj`
- If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<SDK>/examples/snippets/wlan/calibration_app/projects/calibration_app-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<SDK>/examples/snippets/wlan/calibration_app/projects/calibration_app-brd4180b-mg21.slsproj`
- User can find the Radio Board version as given below

![EFR Radio Boards](resources/readme/image_c10.png)


### 3.4 Bare Metal Support

This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the release package.
This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the SDK.

## 4. Application Configuration Parameters

Expand Down Expand Up @@ -144,7 +144,7 @@ Follow the steps below for the successful execution of the application.

### 5.1 Loading the RS9116W Firmware

Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK. The firmware file is located in `<Release_Package>/firmware/`
Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK. The firmware file is located in `<SDK>/firmware/`


### 5.2 Building the Application on Host Platform
Expand All @@ -153,7 +153,7 @@ Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconn

Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-stm32/)

- Open the project `<Release_Package>/examples/snippets/wlan/calibration_app/projects/calibration_app-nucleo-f411re.uvprojx`
- Open the project `<SDK>/examples/snippets/wlan/calibration_app/projects/calibration_app-nucleo-f411re.uvprojx`
- Build and Debug the project
- Check for the RESET pin:
- If RESET pin is connected from STM32 to RS9116W EVK, then user need not press the RESET button on RS9116W EVK before free run.
Expand All @@ -165,7 +165,7 @@ Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/la

Refer [Getting started with EFX32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-efx32/)

- Open Simplicity Studio and import the project from `<Release_Package>/examples/snippets/wlan/calibration_app/projects`
- Open Simplicity Studio and import the project from `<SDK>/examples/snippets/wlan/calibration_app/projects`
- Select the appropriate .slsproj as per the Radio Board type mentioned in **Section 3.3**
- Compile and flash the project in to Host MCU
- Debug the project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,20 +74,20 @@ The Application is provided with the project folder consists of Keil and Simplic

- The Keil can be executed on STM32 platform.

- Project Path : `<Release_package>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-nucleo-f411re.uvprojx`
- Project Path : `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-nucleo-f411re.uvprojx`

* Simplicity Studio :

- The Simplicity Studio project can be executed on EFR32MG21.

- Project Path :
- If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<Release_Package>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<Release_Package>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-brd4180b-mg21.slsproj`
- If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-brd4180b-mg21.slsproj`


### 3.4 Bare Metal Support

This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the release package.
This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the SDK.


## 4. Application Configuration Parameters
Expand Down Expand Up @@ -191,14 +191,14 @@ IP address of the network mask should also be in long format and in little endia

### 4.4 To Load Certificate

**rsi\_wlan\_set\_certificate()** API expects the certificate in the form of linear array. Convert the pem certificate into linear array form using python script provided in the release package `<Release_Package>/resources/certificates/certificate_script.py`.
**rsi\_wlan\_set\_certificate()** API expects the certificate in the form of linear array. Convert the pem certificate into linear array form using python script provided in the SDK `<SDK>/resources/certificates/certificate_script.py`.

> For example : If the certificate is ca-certificate.pem, enter the command in the following way:
> python certificate_script.py ca-certificate.pem
> The script will generate ca-certificate.pem in which one linear array named ca-certificate contains the certificate.
Root CA certificate, Device private key and Device client certificate needs to be converted as mentioned above

After the conversion, place the converted files in `<Release_Package>/resources/certificates/` path and include the certificate files in device_shadow_logging_stats.c
After the conversion, place the converted files in `<SDK>/resources/certificates/` path and include the certificate files in device_shadow_logging_stats.c

```c
Replace the default Device certificate and Private key certificate include in the application with the converted pem file name.
Expand Down Expand Up @@ -243,7 +243,7 @@ Follow the steps below for the successful execution of the application.
Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK.
The firmware file is located in `<Release_Package>/firmware/`
The firmware file is located in `<SDK>/firmware/`
### 5.2 Building the Application on Host Platform
Expand All @@ -252,8 +252,8 @@ The firmware file is located in `<Release_Package>/firmware/`
Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-stm32/)
- Configure STM32 CN10 header pin-30(PB13) should connect to UULP_GPIO_0 and STM32 pin-2 should connect to UULP_GPIO_0.
- Open the project `<Release_package>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-nucleo-f411re.uvprojx`
- Configure STM32 CN10 header pin-30(PB13) should connect to UULP_GPIO_0 and STM32 pin-2 should connect to UULP_GPIO_2.
- Open the project `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\projects\device_shadow_logging_stats-nucleo-f411re.uvprojx`
- Build and debug the project.
- Check for the RESET pin:
- If RESET pin is connected from STM32 to RS9116W EVK, then user need not press the RESET button on RS9116W EVK before Free run.
Expand All @@ -268,7 +268,7 @@ Refer [Getting started with EFX32](https://docs.silabs.com/rs9116-wiseconnect/la
- Configure EFX32 pin-9(PD03/PB01 GPIO) should connect to UULP_GPIO_0 and EVFX32 pin-7(PD02/PB00 GPIO) should connect to UULP_GPIO_2.
- Open Simplicity Studio and import the project `<Release_Package>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\project`
- Open Simplicity Studio and import the project `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\device_shadow_logging_stats\project`
- Select the appropriate .slsproj as per the Radio Board type mentioned in **Section 3.3**
- Compile and flash the project in to Host MCU
- Debug the project
Expand Down
18 changes: 9 additions & 9 deletions examples/snippets/wlan/cloud_apps/aws_iot/mqtt/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,16 @@ The Application is provided with the project folder consists of Keil and Simplic

- The Keil can be executed on STM32 platform.

- Project Path : `<Release_package>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-nucleo-f411re.uvprojx`
- Project Path : `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-nucleo-f411re.uvprojx`

* Simplicity Studio :
- The Simplicity Studio project is used to evaluate the application on EFR32MG21.
- Project Path : If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<Release_Package>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<Release_Package>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-brd4180b-mg21.slsproj`
- Project Path : If the Radio Board is **BRD4180A** or **BRD4181A**, then access the path `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-brd4180a-mg21.slsproj`
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-brd4180b-mg21.slsproj`

### 3.4 Bare Metal Support

This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the release package.
This application supports only bare metal environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the SDK.


## 4. Application Configuration Parameters
Expand Down Expand Up @@ -195,7 +195,7 @@ IP address of the network mask should also be in long format and in little endia

### 4.4 To Load certificate

**rsi\_wlan\_set\_certificate()** API expects the certificate in the form of linear array. Convert the pem certificate into linear array form using python script provided in the release package `<Release_Package>/resources/certificates/certificate_script.py`.
**rsi\_wlan\_set\_certificate()** API expects the certificate in the form of linear array. Convert the pem certificate into linear array form using python script provided in the SDK `<SDK>/resources/certificates/certificate_script.py`.

```sh
For example : If the certificate is ca-certificate.pem, enter the command in the following way:
Expand All @@ -204,7 +204,7 @@ IP address of the network mask should also be in long format and in little endia
```
Root CA certificate, Device private key and Device client certificate needs to be converted as mentioned above

After the conversion, place the converted files in `<Release_Package>/resources/certificates/` path and include the certificate files in `rsi_subscribe_publish_sample.c`
After the conversion, place the converted files in `<SDK>/resources/certificates/` path and include the certificate files in `rsi_subscribe_publish_sample.c`

```c
Replace the default Device certificate and Private key certificate include in the application with the converted pem file name.
Expand Down Expand Up @@ -247,7 +247,7 @@ User has to follow the below steps for the successful execution of the applicati
### 5.1 Loading the RS9116W Firmware
Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK. The firmware file is located in `<Release_Package>/firmware/`
Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconnect-getting-started) to load the firmware into RS9116W EVK. The firmware file is located in `<SDK>/firmware/`
### 5.2 Building the Application on Host Platform
Expand All @@ -256,7 +256,7 @@ Refer [Getting started with a PC](https://docs.silabs.com/rs9116/latest/wiseconn
Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-stm32/)
- Open the project `<Release_package>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-nucleo-f411re.uvprojx`
- Open the project `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects\aws_iot_mqtt-nucleo-f411re.uvprojx`
- Build and Debug the project.
- Check for the RESET pin:
- If RESET pin is connected from STM32 to RS9116W EVK, then user need not press the RESET button on RS9116W EVK before Free run.
Expand All @@ -268,7 +268,7 @@ Refer [Getting started with STM32](https://docs.silabs.com/rs9116-wiseconnect/la
Refer [Getting started with EFX32](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-getting-started-with-efx32/)
- Open Simplicity Studio and import the project `<Release_Package>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects`
- Open Simplicity Studio and import the project `<SDK>\examples\snippets\wlan\cloud_apps\aws_iot\mqtt\projects`
- Select the appropriate .slsproj as per the Radio Board type mentioned in **Section 3.3**
- Compile and flash the project in to Host MCU
- Debug the project
Expand Down
Loading

0 comments on commit 78d7cd2

Please sign in to comment.