Skip to content

Commit

Permalink
WiSeConnect release 2.8.0 example readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ajisilabs committed Jun 7, 2023
1 parent ed67e1d commit 3d63e6b
Show file tree
Hide file tree
Showing 42 changed files with 145 additions and 84 deletions.
60 changes: 45 additions & 15 deletions examples/snippets/ble/ble_ae_central/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Before running the application, the user will need the following things to setup
- [STM32F411 Nucleo](https://st.com/)
- BLE peripheral device

![figureSetup Diagram for Simple Central Example using RS9116 EVK](resources/AE_central.png)
![figureSetup Diagram for Simple Central Example using RS9116 ACX Expansion board](resources/AC1_AE_Cental.png)
![figureSetup Diagram for Simple Central Example using RS9116 EVK](./resources/ae_central.png)
![figureSetup Diagram for Simple Central Example using RS9116 ACX Expansion board](./resources/ac1_ae_central.png)

### 2.2 Software Requirements

Expand Down Expand Up @@ -62,7 +62,7 @@ The Application is provided with the project folder containing Keil and Simplici
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<SDK>/examples/_internal/Wireless_Examples/ble/ble_ae_central/projects/ble_ae_central-brd4180b-mg21.slsproj`
- User can find the Radio Board version as given below

![EFR Radio Boards](resources/readme/image23a.png)
![EFR Radio Boards](resources/radio-board.png)

- EFM32GG11 platform
- The Simplicity Studio project is used to evaluate the application on EFM32GG11.
Expand Down Expand Up @@ -97,8 +97,10 @@ The application can be configured to suit your requirements and development envi
**Power save configuration**

By default, The Application is configured without power save.

#define ENABLE_POWER_SAVE 0

```c
#define ENABLE_POWER_SAVE 0
```
If user wants to run the application in power save, modify the below configuration.
Expand Down Expand Up @@ -128,41 +130,69 @@ Following are the non-configurable macros in the application.
**4.2** Open `rsi_ble_config.h` file and update/modify following macros,

Initiating phys:
#define INITIATING_PHYS (PHY_1M | PHY_2M | PHY_LE_CODED)

```c
#define INITIATING_PHYS (PHY_1M | PHY_2M | PHY_LE_CODED)
```
Primary phy scan interval:
#define PRI_PHY_LE_SCAN_INTERVAL 0x100
```c
#define PRI_PHY_LE_SCAN_INTERVAL 0x100
```
Primary phy scan window:

#define PRI_PHY_LE_SCAN_WINDOW 0x50
```c
#define PRI_PHY_LE_SCAN_WINDOW 0x50
```
Secondary phy scan interval:
#define SEC_PHY_LE_SCAN_INTERVAL 0x100
```c
#define SEC_PHY_LE_SCAN_INTERVAL 0x100
```

Secondary phy scan window:

#define SEC_PHY_LE_SCAN_WINDOW 0x50
```c
#define SEC_PHY_LE_SCAN_WINDOW 0x50
```
Primary scan type :
#define PRI_PHY_BLE_SCAN_TYPE SCAN_TYPE_ACTIVE
```c
#define PRI_PHY_BLE_SCAN_TYPE SCAN_TYPE_ACTIVE
```

Secondary scan type:

#define SEC_PHY_BLE_SCAN_TYPE SCAN_TYPE_ACTIVE
Scan filter type :
```c
#define SEC_PHY_BLE_SCAN_TYPE SCAN_TYPE_ACTIVE
```

Scan filter type:

#define RSI_BLE_SCAN_FILTER_TYPE SCAN_FILTER_TYPE_ALL
```c
#define RSI_BLE_SCAN_FILTER_TYPE SCAN_FILTER_TYPE_ALL
```
Scan filter duplicates:
```c
#define BLE_SCAN_ENABLE_FILTER_DUP 0x00
```

Scan duration:

```c
#define BLE_SCAN_DUR 0x00
```

Scan period:

```c
#define BLE_SCAN_PERIOD 0x00
```

```c
#define RSI_BLE_PWR_INX 30
#define RSI_BLE_PWR_SAVE_OPTIONS BLE_DISABLE_DUTY_CYCLING
Expand Down Expand Up @@ -230,7 +260,7 @@ Refer [EFx32 Getting Started](https://docs.silabs.com/rs9116-wiseconnect/latest/

4. After successful program execution the prints in docklight looks as shown below.

![Prints in docklight window](resources/ae_central_logs.png)
![Prints in docklight window](./resources/ae_central_logs.png)

## Compressed Debug Logging

Expand Down
File renamed without changes
91 changes: 57 additions & 34 deletions examples/snippets/ble/ble_ae_peripheral/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ Before running the application, the user will need the following things to setup
- [STM32F411 Nucleo](https://st.com/)
- BLE peripheral device

![figureSetup Diagram for Simple Central Example](resources/readme/images23.png)
![figureSetup Diagram for AE Peripheral Example using RS9116 EVK](./resources/ae_peripheral.png)
![figureSetup Diagram for AE Peripheral Example using RS9116 ACX Expansion board](./resources/ac1-ae-peripheral.png)



### 2.2 Software Requirements

Expand Down Expand Up @@ -61,7 +64,7 @@ The Application is provided with the project folder containing Keil and Simplici
- If the Radio Board is **BRD4180B** or **BRD4181B**, then access the path `<SDK>/examples/_internal/Wireless_Examples/ble/ble_ae_peripheral/projects/ble_ae_peripheral-brd4180b-mg21.slsproj`
- User can find the Radio Board version as given below

![EFR Radio Boards](resources/AE_peripheral.png)
![EFR Radio Boards](./resources/radio-board.png)

- EFM32GG11 platform
- The Simplicity Studio project is used to evaluate the application on EFM32GG11.
Expand All @@ -80,29 +83,36 @@ The application can be configured to suit your requirements and development envi
**4.1.1** User must update the below parameters

Set below macro to enable second set of advertising
```c
#define ADV_SET2 1
```

#define ADV_SET2 1
The length of the advertising data needs to be filled in the following macro

#define BLE_AE_ADV_DATA_LEN 0x19
```c
#define BLE_AE_ADV_DATA_LEN 0x19
```

Below mentioned macro needs to be populated with data

#define BLE_AE_ADV_DATA "AE_PERIPHERAL_DATA_1"
```c
#define BLE_AE_ADV_DATA "AE_PERIPHERAL_DATA_1"
```

Mention the address type of the device which needs to be whitelisted

#define RSI_BLE_WHITELIST_DEV_ADDR1_TYPE LE_RANDOM_ADDRESS
```c
#define RSI_BLE_WHITELIST_DEV_ADDR1_TYPE LE_RANDOM_ADDRESS
```
Fill the address of the device to be whitelisted in the below mentioned variable

ble_whitelist_addr1[6] = { 0xDA, 0x81, 0xE0, 0xB8, 0xB9, 0x42 };
```c
ble_whitelist_addr1[6] = { 0xDA, 0x81, 0xE0, 0xB8, 0xB9, 0x42 };
```

**Power save configuration**

By default, The Application is configured without power save.

#define ENABLE_POWER_SAVE 0
```c
#define ENABLE_POWER_SAVE 0
```
If user wants to run the application in power save, modify the below configuration.
Expand Down Expand Up @@ -132,42 +142,55 @@ Following are the non-configurable macros in the application.
**4.2** Open `rsi_ble_config.h` file and update/modify following macros,

The minimum avertising interval:
```c
#define RSI_BLE_ADV_INT_MIN 0x020
```

#define RSI_BLE_ADV_INT_MIN 0x020
The maximum advertising interval:
```c
#define RSI_BLE_ADV_INT_MAX 0x020
```

#define RSI_BLE_ADV_INT_MAX 0x020
Channel map selection:
```c
#define RSI_BLE_ADV_CHANNEL_MAP 0x07
```
#define RSI_BLE_ADV_CHANNEL_MAP 0x07

Maximum extended advertisingevents:

#define BLE_MAX_AE_EVNTS 0
Maximum extended advertisingevents:
```c
#define BLE_MAX_AE_EVNTS 0
```

Extended advertising filter policy
```c
#define BLE_AE_ADV_FILTER_POLICY 0x00
```
#define BLE_AE_ADV_FILTER_POLICY 0x00
Extended advertising TX Power

#define BLE_AE_ADV_TX_PWR 0x7f
```c
#define BLE_AE_ADV_TX_PWR 0x7f
```

Secondary advertising max skip count:
```c
#define BLE_AE_SEC_ADV_MAX_SKIP 0x00
```
#define BLE_AE_SEC_ADV_MAX_SKIP 0x00
Advertising SID

#define BLE_AE_ADV_SID 0x00
```c
#define BLE_AE_ADV_SID 0x00
```

Event properties can be set by enabling the respective bits in the following macros

#define BLE_CONNECTABLE_ADV (1 << 0)
#define BLE_SCANNABLE_ADV (0 << 1)
#define BLE_LOW_DUTY_DIR_CONN_ADV (0 << 2)
#define BLE_HIGH_DUTY_DIR_CONN_ADV (0 << 3)
#define BLE_LEGACY_ADV (0 << 4)
#define BLE_ANONYMOUS_ADV (0 << 5)
#define BLE_TX_WR_ADV (0 << 6)
```c
#define BLE_CONNECTABLE_ADV (1 << 0)
#define BLE_SCANNABLE_ADV (0 << 1)
#define BLE_LOW_DUTY_DIR_CONN_ADV (0 << 2)
#define BLE_HIGH_DUTY_DIR_CONN_ADV (0 << 3)
#define BLE_LEGACY_ADV (0 << 4)
#define BLE_ANONYMOUS_ADV (0 << 5)
#define BLE_TX_WR_ADV (0 << 6)
```
```c
#define RSI_BLE_PWR_INX 30
#define RSI_BLE_PWR_SAVE_OPTIONS BLE_DISABLE_DUTY_CYCLING
Expand Down
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions examples/snippets/ble/ble_central/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,10 @@ LE_PUBLIC_ADDRESS
**Power save configuration**

By default, The Application is configured without power save.

#define ENABLE_POWER_SAVE 0

```c
#define ENABLE_POWER_SAVE 0
```
If user wants to run the application in power save, modify the below configuration.
Expand Down
2 changes: 1 addition & 1 deletion examples/snippets/ble/ble_testmodes/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
#define RSI_BLE_PWR_INX 30
#define RSI_BLE_PWR_SAVE_OPTIONS 0

```
```text
Note:
rsi_bt_config.h, rsi_wlan_config.h and rsi_ble_config.h files are already set with the desired configuration in respective example folders user need not change for each example.
```
Expand Down
7 changes: 3 additions & 4 deletions examples/snippets/ble/gatt_long_read/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The WiSeConnect parts require that the host processor is connected to the WiSeCo
**RSI_REMOTE_DEVICE_NAME** refers the name of remote device to which Silicon Labs device has to connect
#define RSI_REMOTE_DEVICE_NAME "SILABS_DEV"

```
```text
Note:
Silicon Labs module can connect to remote device by referring either RSI_BLE_DEV_ADDR or RSI_REMOTE_DEVICE_NAME of the remote device.
```
Expand Down Expand Up @@ -130,6 +130,5 @@ The WiSeConnect parts require that the host processor is connected to the WiSeCo
6. After connecting, mtu size will be updated. As per mtu size, write will be happen from Silicon Labs device
7. In either role: If mtu size is of 100 bytes, module can read upto 98 bytes, write upto 97 bytes
8. For the data more than 20 bytes, application has to store value and send using gatt_read_response function whenever remote device reads some handle's data.

For read request event to be raised auth_read flag in rsi_ble_add_char_val_att function need to be set.
Based on GATT_ROLE configurable macro, this application will be act as a GATT server or GATT client device.
For read request event to be raised auth_read flag in rsi_ble_add_char_val_att function need to be set.
Based on GATT_ROLE configurable macro, this application will be act as a GATT server or GATT client device.
4 changes: 2 additions & 2 deletions examples/snippets/wlan/tcp_logging_stats/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ The Application is provided with the project folder containing Keil and Simplici
![EFR Radio Boards](resources/readme/image205a.png)

- EFM32GG11 platform
- The Simplicity Studio project is used to evaluate the application on EFM32GG11.
- Project path:`<SDK>/examples/snippets/wlan/tcp_logging_stats/projects/tcp_logging_stats-brd2204a-gg11.slsproj`
- The Simplicity Studio project is used to evaluate the application on EFM32GG11.
- Project path:`<SDK>/examples/snippets/wlan/tcp_logging_stats/projects/tcp_logging_stats-brd2204a-gg11.slsproj`


### 3.4 Bare Metal/RTOS Support
Expand Down
Loading

0 comments on commit 3d63e6b

Please sign in to comment.