id
stringlengths 14
15
| text
stringlengths 18
2.08k
| source
stringlengths 33
117
|
|---|---|---|
aa4b7309637d-0 | You are viewing documentation for version: 2.6 | Version History
RS9116W BT Classic AT Command PRM
About this Document
This document describes the Bluetooth (BT) Classic commands; including parameters used in commands, valid values for each command, and expected responses from the RS911X Modules. This document is also used to write software for the Host MCU to control and operate the module. | rtdocs\docs.silabs.com\rs9116\wiseconnect\rs9116w-bt-classic-at-command-prm\latest\index.html |
3b800a8b0042-0 | You are viewing documentation for version: 2.6 | Version History
Software Architecture
Overview
The RS9116 WiSeConnect module includes Wi-Fi, TCP/IP and BT 5 stacks embedded in its internal flash memory. This module requires a separate application processor which acts as a host. Host can communicate with RS9116 module using one of the interfaces listed below.
RS9116W Block Diagram
RS9116W Block Diagram
RS9116 supports following interfaces for interacting with host.
SPI
UART
SDIO
Note!
SDIO interface is currently not supported in the WiseConnect firmware.
The host can use either Simple APIs or AT Commands for configuring the module.
There are two modes for host interaction:
AT Mode (ASCII)
In this mode, host should use AT Commands for interacting with RS9116 Module. This mode can be used only with UART / USB-CDC interface. Section 'AT Command Mode' provides more details about this mode. Section 'WLAN Commands' describes all commands and other required details.
Binary Mode
In this mode, the host should use Binary Commands for interacting with RS9116 Module. This mode can be used with UART, SPI and SDIO interfaces. Section 'Binary Command Mode' provides more details about this mode. Section 'WLAN Commands' describes all commands and other required details.
Host Interface block diagram is shown below,
RS9116W Host Interface Block Diagram
WLAN Architecture
The following figure depicts the WLAN software architecture of the RS9116-WiSeConnect.
RS9116 WLAN Software Architecture
Application
The application layer invokes Simple APIs or AT Commands provided by SPI/ UART/SDIO driver. The application developer can use these APIs to build wireless applications.
SPI | rtdocs\docs.silabs.com\rs9116\wiseconnect\rs9116w-wifi-at-command-prm\latest\index.html |
3b800a8b0042-1 | SPI
The SPI interface on the RS9116-WiSeConnect works in slave mode. It is a 4-wire interface. In addition to the SPI interface, the module provides additional interrupt pin to signal events to the host.
The interrupt is raised by the module in SPI mode for the following condition.
When the module has data in its output buffer, it indicates host by raising active high signal on the interrupt pin.
The interrupt from module is active high and host has to configure the interrupt in level trigger mode.
UART
The UART interface on the RS9116-WiSeConnect transmits/receives data to/from the Host in UART mode.
SDIO
The SDIO interface on the RS9116-WiSeConnect transmits/receives data to/from the Host in SDIO mode.
Host Abstraction Layer (HAL)
The HAL abstracts the lower layers in the Host interface to which the RS9116-WiSeConnect is connected. The HAL interacts with the Wireless Control Block layer for the processing of the frames obtained from or destined to the Host.
Wireless Control Block (WCB)
The data from/to the Host is classified as Wi-Fi specific frames or TCP/IP specific frames. The functionality of the WCB module depends on the type and direction of the frames.
Wi-Fi Control Frames (WCF)
The WCB interprets the Wi-Fi control information from the Host and interacts with the SME (Station Management Entity) or APME (Access Point Management Entity) based on operating mode of RS9116- WiSeConnect. Configuration of the RS9116-WiSeConnect from the Host for Wi-Fi access is through AT commands or Binary commands.
TCP/IP Control Frames
TCP/IP networking protocol provides end-to-end connectivity specifying how data should be formatted, addressed, transmitted, routed and received at the destination. | rtdocs\docs.silabs.com\rs9116\wiseconnect\rs9116w-wifi-at-command-prm\latest\index.html |
3b800a8b0042-2 | If the packets received from the Host by WCB during transmission is interpreted as TCP/IP frames then the WCB interacts with TCP/IP stack for further processing before passing the packets to MAC layer.
Similarly if the packets are received from the TCP/IP stack by WCB during reception, WCB processes before passing these packets to host.
Station Management Entity (SME)
The SME is the core layer which manages the Wi-Fi connectivity in Station mode. The SME maintains the state machine to detect the activity on the Wi-Fi network and indicates to the user accordingly. It interacts with the WPA supplicant if security is enabled in the Wi-Fi network.
Access Point Management Entity (APME)
The APME is the core layer which manages the connectivity in Access Point group owner modes. The APME maintains the state machine to handle multiple clients connected to the module. It interacts with WPA supplicant if security is enabled in the Wi-Fi network.
WPA Supplicant
The main functionality of WPA supplicant is to support the key negotiation between Wi-Fi devices in a secure mode. This functionality depends on the mode in which RS9116-WiSeConnect operates in Station mode, Access point mode. The WPA supplicant is used to initiate the 802.1x/E Access Point authentication if WPA/WPA2-PSK is used as the security parameter. It also plays a major part in performing the 4-way handshake to derive the PTK in WPA/WPA2-PSK modes. | rtdocs\docs.silabs.com\rs9116\wiseconnect\rs9116w-wifi-at-command-prm\latest\index.html |
671c2f3070d4-0 | You are viewing documentation for version: 2.6 | Version History
SAPI Overview#
The RS9116W Simple API (SAPI) is a comprehensive collection of Wireless, Network Applications, BSD Socket APIs, and RS9116 driver code along with different HALs for mapping to platform interface on which the library may be ported.
This documentation in this section describes the RS9116 WiSeConnect SAPI (Simple API) library, including:
Brief descriptions about the RS9116 WiSeConnect SAPI Architecture
Details about the APIs and configurations available in the SAPI library
Recent updates of the SAPI library changes
SAPI is intended to run on a host MCU with/without RTOS. Use the given APIs without any modifications to make upgrading to future releases easier. Make sure you also update SAPI with the RS9116 device firmware.
RS9116 device includes Wi-Fi, TCP/IP Networking stack with SSL/TLS support up to TLS 1.2, HTTP/HTTPS, Web sockets, DHCP, MQTT client, and Bluetooth 5 stacks embedded. This device requires a separate application processor, which acts as a host. Host can communicate with RS9116 device using one of the interfaces listed below.
RS9116 supports the following interfaces for host interaction:
SPI
UART
SDIO
USB-CDC
SAPI enables easy migration into any platform with its uniform APIs. This library simplifies application development on the host. Users can develop application software without learning the underlying peripheral register interface and other details. | rtdocs\docs.silabs.com\rs9116-wiseconnect\2.6\wifibt-wc-sapi-reference\index.html |
671c2f3070d4-1 | RS9116W release consists of two main components, Firmware and SAPI Library. Both components have the same revision number as they are tightly coupled. Latest releases might have bug fixes, enhancements, and new features in SAPI and/or Firmware. Most of the new features have associated APIs, which are available in the latest SAPI release only. It is recommended to always update SAPI and Firmware to same release version.
Features#
Platform-independent, interrupt-driven drivers written in C.
Drivers provide a simpler, functional interface and eliminate the need to manage the low-level host interface protocol.
Common APIs for four host interfaces (SPI, UART, SDIO, USB-CDC), which enables easy migration to different host interfaces.
Supports bare metal and FreeRTOS OS by default. Other RTOS can be supported through OS Abstraction changes.
May be used with Simplicity Studio, Keil uVision and IAR IDEs. The SAPI driver can also be ported for use with other IDEs that use GCC or ARM compiler toolchains. | rtdocs\docs.silabs.com\rs9116-wiseconnect\2.6\wifibt-wc-sapi-reference\index.html |
ebcd3ecad576-0 | You are viewing documentation for version: 2.6 (latest) | Version History
RS9116 Evaluation Kit#
The RS9116 Evaluation Kit (EVK) includes everything necessary to Get Started with PC using AT Commands or to connect to a host MCU (not included) as described in Getting Started with EFx32 Host or Getting Started with STM32 Host.
The RS9116 EVK is available in several varieties as listed below. Unless otherwise noted, the software support and operational instructions are the same for all varieties.
RS911X-DB-EVK1 - Dual Band Wi-Fi + Bluetooth Evaluation Kit with CC1 Module
RS911X-SB-EVK1 - Single Band Wi-Fi + Bluetooth Evaluation Kit with QMS SoC
RS911X-SB-EVK2 - Single Band Wi-Fi + Bluetooth Evaluation Kit with B00 Module
Complete details of the EVKs are available in the RS9116 EVK User's Guide. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-rs9116x-evk\index.html |
27031352715d-0 | You are viewing documentation for version: 2.6 (latest) | Version History
Application Notes#
The Application Notes listed below cover key topics related to RS9116W WiSeConnect™. For a complete list of technical documentation and resources, see: RS9116 Technical Resources.
Wi-Fi Regulatory Testing App Note#
Guide for Wi-Fi regulatory testing
Hardware and software requirements and setup
Configure and execute regulatory test modes
Bluetooth Regulatory Testing App Note#
Guide for Bluetooth and BLE regulatory testing
Hardware and software requirements and setup
Configure and execute regulatory test modes
Power Save App Note#
Guide to evaluate low power features using the RS9116 EVK
Hardware and software requirements and setup
Procedure for performing power measurements
Wi-Fi Throughput App Note#
Guide to evaluate and measure Wi-Fi throughput using the RS9116 EVK
Hardware and software requirements and setup
Setup and use the throughput reference project
Procedure for performing throughput measurements
Firmware Update App Note#
Guide to firmware update mechanisms offered for RS9116W
Describes firmware update options using SPI, USB and Wireless interfaces
SPI Protocol App Note#
Details of the SPI implementation of the RS9116W
RS9113 to RS9116 Migration Guide#
Guide for migrating an application from (legacy) RS9113 products to RS9116W
RS9113 and RS9116 part number compatibility
Hardware and software migration requirements | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-application-notes\index.html |
570ca68397c7-0 | You are viewing documentation for version: 2.6 (latest) | Version History
AT Command Examples#
The AT-Command examples provided in the WiSeConnect™ SDK are Tera Term scripts that demonstrate basic RS9116W functionality using only a RS9116 Evaluation Kit and a PC. More details can be found in Getting Started with PC using AT Commands
The scripts are found in the WiSeConnect™ SDK at the path <SDK>/examples/at_commands
Details on the configuration and operation of each example are available in the readme.md file that is found with the example source code and at the following links:
BLE CentralDemonstrates setting up the device as a BLE Central device.
BLE Heart Rate ProfileDemonstrates setting up the device as a Bluetooth Low Energy Heart Rate Profile.
BLE Packet Error RateDemonstrates setting up the device as a BLE PER device.
BLE PeripheralDemonstrates setting up the device as a BLE Peripheral device.
BLE Proximity ProfileDemonstrates setting up the device as a BLE Proximity Profile Device.
BT Packet Error RateDemonstrates setting up the device as a BT PER Transmit/Receive functionality.
BT SPP MasterDemonstrates setting up the device as a Bluetooth Serial Port Profile (SPP) master.
BT SPP SlaveDemonstrates setting up the device as a Bluetooth Serial Port Profile (SPP) Slave.
Wi-Fi Soft APDemonstrates setting up the device as a Wi-Fi Access Point and connecting to it from a mobile phone or PC
Wi-Fi Enterprise AuthenticationDemonstrates connecting to a Wi-Fi access point in station mode using enterprise authenticarion.
Wi-Fi Firmware UpdateDemonstrates how to update firmware over Wi-Fi.
Wi-Fi Low PowerDemonstrates Wi-Fi Station standby associated power save functionality allowing the user to measure and evaluate the low-power consumption of the device. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-at-command-examples\index.html |
570ca68397c7-1 | Wi-Fi Low Power + BLEDemonstrates Wi-Fi Station standby associated power save functionality along with BLE advertising.
Wi-Fi StationDemonstrates connecting to a Wi-Fi access point in station mode. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-at-command-examples\index.html |
72735a3397c1-0 | You are viewing documentation for version: 2.6 (latest) | Version History
WiSeConnect™ Example Applications#
The WiSeConnect™ SDK includes a large number of examples that illustrate how to use the RS9116W. Each example includes ready-made projects for EFx32 and STM32 host MCU's that are simple to import into a target IDE and begin development.
To get started using the example applications, follow the instructions in on one of the getting started guides below:
Getting Started with EFx32 Host
Getting Started with STM32 Host
Getting Started with PC using AT Commands
The examples may be run on many other embedded host MCU's by porting the WiSeConnect™ driver software as described in the RS9116W SAPI Porting Guide.
The examples included in the WiSeConnect™ SDK are organized into the following types. Each example includes documentation that describes how to configure and operate the example. More details are available at the links below:
Featured Examples - Full featured projects that demonstrate a common RS9116 use-case or enable you to perform a key aspect of RS9116 evaluation.
Snippet Examples - Smaller projects that focus on one particular feature or API.
AT Command Examples - Pre-built Tera Term scripts used for evaluating the RS9116 directly from a PC. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-example-applications-overview\index.html |
3743be720e42-0 | You are viewing documentation for version: 2.6 (latest) | Version History
Featured Examples#
Featured examples are complete projects that demonstrate a common RS9116 use-case or enable you to perform a key aspect of RS9116 evaluation. The featured examples are found in the WiSeConnect™ SDK at the path: <SDK>/examples/featured.
Details on the configuration and operation of each featured example are available in the readme.md file that is found with the example source code and at the following links:
AWS IoT Device ShadowCreates an AWS IoT 'thing' that connects to the AWS IoT device shadow service using the MQTT protocol
BLE PER - Transmit and Receive Performance and Regulatory Testingconfigure the device with necessary parameters to start transmitting or receiving BLE PER packets.
BT PER - Transmit and Receive Performance and Regulatory Testingconfigure the device with necessary parameters to start transmitting or receiving BT PER packets.
Firmware Update via TCP ServerWirelessly updates the RS911x firmware from a remote TCP server
Deep-Sleep UDP ClientConnects to a Wi-Fi Access Point in deep-sleep mode and intermittently wakes to send UDP packets
Transmit Performance and Regulatory TestingConfigures the device in a transmit mode that is used for transmit performance and regulatory certification testing (FCC, ETSI, CE, etc.)
Throughput TestMeasures Wi-Fi transmit/receive throughput performance using a remote iPerf client/server | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-featured-examples\index.html |
1f887e41fdbb-0 | You are viewing documentation for version: 2.6 (latest) | Version History
Getting Started with an EFx32 Host#
This guide describes how to get started developing a RS9116W application on an EFx32 embedded host MCU using the WiSeConnect™ Simple Application Programming Interface (SAPI). For quick evaluation using only the EVK and a PC instead see Getting Started with PC using AT Commands.
Getting started with application development on an EFx32 involves the following steps:
Download and Install Simplicity Studio
Choose a host MCU Development Board
Update the RS9116W Firmware
Connect the RS9116 EVK to the EFx32 development board
Open a Featured Example Project in Simplicity Studio
Build, Run and Debug an example project
Explore the WiSeConnect™ Software Driver Package
Import Snippet Example Projects into Simplicity Studio
Download and Install Simplicity Studio#
Simplicity Studio is available for download at www.silabs.com/simplicity-studio. The steps outlined in this getting started guide require Simplicity Studio version 5.1.2 or later.
During installation, be sure to install the Technology Type: 32-Bit Microcontrollers. More details can be found at Simplicity Studio Installation Instructions
Note!
The WiSeConnect™ Software Driver Package is automatically downloaded by Simplicity Studio. More details can be found in the section, Explore the WiSeConnect™ Software Driver Package.
Choose a host MCU Development Board# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-1 | Choose a host MCU Development Board#
The example projects provided with the WiSeConnect™ Software Driver Package are designed to work out-of-the-box with the EFR32MG21 Wireless Starter Kit (SLWSTK6006A) or EFM32GG11 Starter Kit (SLSTK3701A) and the RS9116 Wi-Fi + Bluetooth Development Kit. Project files are provided for both the EFR32MG21 radio board version A (BRD4180A) and version B (BRD4180B), EFM32GG11 radio board version (BRD2204A)
The WiSeConnect™ driver software also works with other embedded host MCUs. Details on porting the driver to other host MCUs can be found in the RS9116W SAPI Porting Guide.
Update the RS9116W Firmware#
When you first receive a RS9116 EVK, or when updating to a new version of the WiSeConnect™ Software Driver Package, we recommend updating the RS9116W firmware to the latest available version. There are several ways to update firmware, but the recommended method to get started is outlined in the section, Updating RS9116W Firmware.
Note!Disconnect the RS9116 EVK from the host MCU board before updating the firmware, the host MCU connections may interfere with the update process.
Connect the RS9116 EVK to the host MCU development board#
For EFR32MG21 host MCU#
Connect the EFR32 Starter Kit, EXP adapter board and RS9116 EVB as illustrated in the following picture:
Note!
The EXP adapter board is included in the RS9116 Evaluation Kit. If you have an older RS9116 Evaluation Kit that does not include the EXP adapter board, please request one through your local sales representative.
STEP 1. Connect the EXP adapter board to the EFR32 starter kit EXP header. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-2 | STEP 1. Connect the EXP adapter board to the EFR32 starter kit EXP header.
STEP 2. Connect the EXP adapter board to the SPI connector of the RS9116 EVK using the 10-pin ribbon cable provided with the RS9116 EVK.
STEP 3. Connect the RST_PS pin on the RS9116 EVK to the pin labeled 11 on the J4 header of the EXP adapter board using a jumper wire.
STEP 4. Set the ISP switch on the RS9116 EVK to the OFF position.
STEP 5. Connect the RS9116 EVK to a PC using the USB interface labeled POWER. Note that this connection only provides power to the EVK. There is no USB communication over this connection.
STEP 6. Connect the EFR32 Starter Kit to a PC using the Mini USB connector on the EFR32 Starter Kit.
Complete hardware details of the RS9116 EVK can be found in the RS9116 EVK User's Guide.
Power Save GPIO Connections#
The instructions above enable basic operation between the host MCU and RS9116. Some low power examples require additional connections of the Ultra Low Power (ULP) GPIOs as detailed in the table below. These details are valid for any example provided in the WiSeConnect™ SDK unless otherwise noted in the readme documentation of a particular example.
Signal Name
EXP Adapter Board
RS9116 EVK
Notes
UULP_0 / UULP_3
J4 Pin 9
J9 Pin 5
If using a RS9116 EVK version 1.4 or newer connect UULP_0. Otherwise connect UULP_3
UULP_2
J4 Pin 7
J9 Pin 4
For EFM32GG11 host MCU# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-3 | J9 Pin 4
For EFM32GG11 host MCU#
Connect the EFM32 Starter Kit and RS9116 EVB as illustrated in the following picture:
STEP 1. Connect one end of the SDIO connector to EFM32 board using the SDIO Pin Configuration Table given below.
STEP 2. Connect the other end of SDIO connector to the RS9116 EVK.
STEP 3. Connect the RST_PS pin on the RS9116 EVK to the PIN11 on EFM32 board using a jumper wire.
STEP 4. Set the ISP switch on the RS9116 EVK to the OFF position.
STEP 5. Connect the RS9116 EVK to a PC using the USB interface labeled POWER. Note that this connection only provides power to the EVK. There is no USB communication over this connection.
STEP 6. Connect the EFM32 Starter Kit to a PC using the Mini USB connector on the EFM32 Starter Kit.
Complete hardware details of the RS9116 EVK can be found in the RS9116 EVK User's Guide.
SDIO Pin Configuration Table :#
Pins on EFM32
On Expansion Header
Pins on RS9116 EVK
PIN#
Signal
PIN#
14
SDIO_DAT2
12
SDIO_DAT3
SDIO_CMD
10
SDIO_CLK
SDIO_DAT0
SDIO_DAT1
GND
20
3V3
Power Save GPIO Connections#
The instructions above enable basic operation between the host MCU and RS9116. Some low power examples require additional connections of the Ultra Low Power (ULP) GPIOs as detailed in the table below. These details are valid for any example provided in the WiSeConnect™ software package unless otherwise noted in the readme documentation of a particular example. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-4 | RS9116 PWR SAVE GPIOs peripheral J9 Header Pin
EFM32 Pin#
Function
Comment
UULP_0 / UULP_3
GPIO
If using a RS9116 EVK version 1.4 or newer connect UULP_0. Otherwise connect UULP_3
UULP_2
GPIO
Open a Featured Example Project in Simplicity Studio#
The WiSeConnect™ SDK includes a number of examples that are featured in Simplicity Studio. A list of the featured examples along with documentation detailing the operation each example can be found in: Featured Examples. More details on the contents of the software package can be found in: Explore the WiSeConnect™ Software Driver Package.
STEP 1. Open Simplicity Studio and navigate to the Launcher perspective.
STEP 2. Under My Products add the RS9116W Evaluation Kit with EFR32MG21 by typing RS9116 then selecting the kit.
The RS9116 Overview page should now display information about the RS9116 and EFR32MG21 kits.
STEP 3. With the product RS9116W Evaluation Kit with EFR32MG21 selected, navigate to the example projects by clicking on Example Projects & Demos then filter by the RS9116 WiSeConnect SDK as shown below.
Note!
The RS9116W Evaluation Kit with EFR32MG21 that was added in the previous step specifies the EFR32MG21 radio board version B (BRD4180B). If instead you are using a EFR32MG21 radio board version A (BRD4180A) then, prior to selecting an example project, you must select the board under Debug Adapters as shown below. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-5 | STEP 4. Click the Create button for the project that you wish to open. This will display the New Project Wizard which will allow you to rename your project, choose the location of your project and select whether you want the project files linked to the original location or copied into the new project location. Typically, the default settings should be used for all options. Click Finish to exit the wizard and create the new project.
Note!
The mention of "SDK" in the New Project Wizardand in the Simplicity IDE refers to the EFR32 platform SDK known as the Gecko SDK (GSDK) and not the RS9116 WiSeConnect™ SDK.
STEP 5. After creating the project, Simplicity Studio will launch the Simplicity IDE allowing you to build, run and debug the project.
Build, Run and Debug an Example Project on the Development Kit#
You can flash, run and debug the newly created example project simply by clicking on the Debug icon in the Simplicity IDE toolbar. This will build the project, flash it onto the attached STK and open the Debugger Perspective. Unless configured otherwise, the debugger will automatically break execution at the beginning of main allowing the user to step, run, or otherwise debug the application. More details on using the debugger tools can be found at: Using the Debuggers.
To build the project without flashing and executing it, simply click on the Build icon in the Simplicity IDE toolbar. This will build the selected default configuration (debug or release).
A pre-built image can be programmed onto a device using the Flash Programmer which is available by clicking the Program icon in the Simplicity IDE toolbar.
Example specific details such as how to configure and operate the example can be found in Example Applications. The same information is also available in the readme file available with the example project source code.
Explore the WiSeConnect™ Software Driver Package# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-6 | Explore the WiSeConnect™ Software Driver Package#
Simplicity Studio automatically downloads the official WiSeConnect™ SDK repository from the Silicon Labs GitHub space. Therefore no action is required to integrate the software into Simplicity Studio.
For advanced situations, the integration between Simplicity Studio and the The WiSeConnect™ SDK GitHub repository can be managed using the External Repos settings in Simplicity Studio. To view or edit the external repos settings go to Preferences > Simplicity Studio > External Repos as shown below. Here you can add, edit, update, or remove repos. You can also select a specific branch, tag or a commit that you would like to use.
Once downloaded, Simplicity Studio will store the repository in the Simplicity Studio installation folder under ./developer/repos. On a Windows PC this is typicall found at C:\SiliconLabs\SimplicityStudio\v5\developer\repos. You can explore the WiSeConnect™ SDK here.
Note!
Simplicity Studio will not download the full contents of the WiSeConnect™ SDK GitHub repo until the user opens one of the features example projects as described in: Open a Featured Example Project in Simplicity Studio
The WiSeConnect™ SDK is organized into the main folders described below.
Folder
Description
examples
Contains host MCU example projects. The example projects are divided into featured, snippets and at_commands as described below in Example Project Types.
firmware
Contains RS9116 firmware image
platforms
Contains platform specific source code for various available platforms. Other platforms can be supported by following the RS9116W SAPI Porting Guide.
resources
Contains various resources for the example projects and sapi including device certificates and scripts.
sapi
Contains the source code files for the WiSeConnect™ Simple Application Programming Interface (SAPI).
third party | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-7 | third party
Contains third party source code and tools such as freeRTOS, AWS SDK and more.
utilities
Contains varous utilities useful for evaluation and application developent.
Example Project Types#
The examples included in the WiSeConnect™ SDK are divided into the following types:
Featured - Full featured projects that perform a key aspect of RS9116 evaluation or use-case. Featured examples are available directly from Simplicity Studio. Using a featured example is described in :Open a Featured Example Project in Simplicity Studio
Snippets - Smaller projects that focus on one particular feature or API. Snippets can be easily imported into Simplcity Studio as described in: Import Snippet Example Projects into Simplicity Studio.
AT commands - Pre-built Tera Term scripts used for evaluating the RS9116 directly from a PC. More details can be found in: Getting Started with RS9116 EVK and WiSeConnect™.
Import Snippet Example Projects into Simplicity Studio#
Snippet example projects are available in the WiSeConnect™ SDK in the subfolder folder ./examples/snippets. More information about the location of the WiSeConnect™ SDK, the folder structure and the example types can be found in: Explore the WiSeConnect™ Software Driver Package.
Snippet example projects can be easily imported into Simplicity Studio using the steps below:
For EFR32MG21 host MCU#
STEP 1. Select File > Import ... from the Simplicity Studio menu.
STEP 2. Click Browse and navigate to the projects folder in the snippet example that you are wanting to import. In this example we are using the WLAN Station Ping example found at C:\SiliconLabs\SimplicityStudio\v5\developer\repos\wiseconnect\examples\snippets\wlan\station_ping\projects. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
1f887e41fdbb-8 | STEP 3. The project names include the EFR32 board number associated with the project (e.g. brd4180a). Select the project associated with the the board you are using and click Next.
STEP 4. Ensure there are no unresolved settings then click Next
STEP 5. Click Finish. The Simplicity IDE will be displayed with the imported project. You can now build, run and debug the project.
For EFM32GG11 Host MCU#
STEP 1. Select File > Import ... from the Simplicity Studio menu.
STEP 2. Click Browse and navigate to the projects folder in the snippet example that you are wanting to import. In this example we are using the WLAN Station Ping example found at C:\SiliconLabs\SimplicityStudio\v5\developer\repos\wiseconnect\examples\snippets\wlan\station_ping\projects.
STEP 3. The project names include the EFM32 board number associated with the project (e.g. brd2204a). Select the project associated with the the board you are using and click Next.
STEP 4. Ensure there are no unresolved settings then click Next
STEP 5. Click Finish. The Simplicity IDE will be displayed with the imported project. You can now build, run and debug the project. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-efx32\index.html |
831307aa900f-0 | You are viewing documentation for version: 2.6 (latest) | Version History
Getting Started with PC using AT Commands#
The fastest way to get started with the WiSeConnect™ software is to use a RS9116 Evaluation Kit (EVK) and PC with a terminal application such as Tera Term.
To get started with app development on a host MCU instead, see Getting Started with a EFx32 Host or Getting Started with a STM32 Host.
Using AT-Commands and a Tera Term example script, your EVK will be connected to a wireless network in minutes.
There's just a few steps involved:
Download WiSeConnect™ software
Connect the EVK
Verify the RS9116 firmware version
Run Tera Term example scripts
Download WiSeConnect™#
The software package is available directly in Simplicity Studio for Silicon Labs EFx32 hosts. See Getting Started with a EFx32 Host. For other MCU hosts or if you are not using Simplicity Studio, the software package can be downloaded directly from the Silicon Labs GitHub space.
Download the latest WiSeConnect™ Software Driver Package
Additional Software Requirements
The terminal program Tera Term is required to complete the steps in this guide. Other terminal programs can be used to control the RS9116W however the example scripts used in this guide will only work with Tera Term. Download Tera Term for PC.
Connect the EVK#
STEP 1. Connect the EVK to a PC using the USB interface labeled UART as identified below.
There are several USB connectors on the RS9116 EVK. For the purposes of basic evaluation using a PC, the UART port is recommended due to its low power consumption. Alternatively, the USB-CDC interface can be used to achieve higher throughput. When using the USB-CDC interface the basic operation outlined on this page remains the same. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-pc\index.html |
831307aa900f-1 | STEP 2. If this is the first time connecting the EVK to your PC, verfy that it is properly detected by the PC. The EVK will appear to the PC as a COM port labeled USB Serial Port (COMx). If the EVK is not properly detected you may need to download and install the FTDI Virtual COM Port (VCP) driver.
STEP 3. Configure your terminal application with the following settings:
Configure the serial port settings to 115200 baud / 8-bit data / No parity / 1 stop bit
Enable local echo
Set receive and transmit new-line characters to CR+LF
See, Tera Term setup instructions.
Verify the RS9116 Firmware Version#
If this is the first time using the RS9116 EVK or if you recently downloaded a new version of the WiSeConnect™ Software Driver Package, the firmware that is currently installed on the EVB may be outdated and may require updating. The instructions below describe how to load and check the firmware version. For instructions on how to update the firmware see, Updating the RS9116W EVK Firmware
STEP 1. After power-up or reset, enter the bootloader as follows (this sequence sends the key combination |U).
press and hold Shift
press then release | (the 'vertical line' or 'pipe' character)
press then release u
release Shift
The console displays the bootloader menu after the characters |UU as shown in the following example.
1.0
1 Load Default Wireless Firmware
A Load Wireless Firmware
(Image No
0-f
)
B Burn Wireless Firmware
(Image No
0-f
5 Select Default Wireless Firmware
(Image No
0-f
)
K Check Wireless Firmware Integrity
(Image No
0-f
7 Enable GPIO Based Bypass Mode
8 Disable GPIO Based Bypass Mode
Q Update KEY
Z JTAG Selection | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-pc\index.html |
831307aa900f-2 | 8 Disable GPIO Based Bypass Mode
Q Update KEY
Z JTAG Selection
Note!
The bootloader menu does not appear automatically on boot because the device waits to perform Auto Baud Rate Detection (ABRD). The character sequence Shift + | followed by Shift + u initiates ABRD causing the device to enter bootloader mode. For more details on ABRD and the bootloader, see the RS9116W Programming Reference Manuals.
|UU
WELCOME TO REDPINE SIGNALS
BootLoader Version
1.0
1 Load Default Wireless Firmware
A Load Wireless Firmware
(Image No
0-f
)
B Burn Wireless Firmware
(Image No
0-f
5 Select Default Wireless Firmware
(Image No
0-f
)
K Check Wireless Firmware Integrity
(Image No
0-f
7 Enable GPIO Based Bypass Mode
8 Disable GPIO Based Bypass Mode
Q Update KEY
Z JTAG Selection
11
Loading
...
Loading Done
Note!
The bootloader automatically loads the default firmware after 20 seconds if a selection is not made.
If the console only displays Loading... without Loading Done, the device may be in legacy binary mode. See, Switching between legacy binary mode and AT-command mode.
The device can be configured in 'Bootloader Bypass Mode' as described in the RS9116W Programming Reference Manuals.
STEP 3. Query the version of the firmware by typing the command at+rsi_fwversion? as shown in the following console example.
...
Loading
...
Loading Done
at+rsi_fwversion?
OK1610.2.4.0.0036 | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-pc\index.html |
831307aa900f-3 | at+rsi_fwversion?
OK1610.2.4.0.0036
STEP 4. If the firmware version does not match the firmware image provided with the WiSeConnect™ SDK, then a firmware update is required. The firmware image is found in the WiSeConnect software package at the path <SDK>/firmware. The firmware version is specified as part of the file name. For update instructions see, Updating the RS9116W EVK Firmware.
Run Tera Term Example Scripts#
The WiSeConnect™ SDK includes several Tera Term example scripts that use AT-Commands to demonstrate basic RS9116W functionality. The scripts are found in the WiSeConnect™ SDK in the folder <SDK>/examples/at_commands/teraterm
When using these examples to evaluate power consumption please use the UART interface as described in Connect the EVK.
A complete list of examples and and instructions on running each example can be found in AT Command Examples.
It is recommended that you start with the Wi-Fi Station Mode Example. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-pc\index.html |
f1b042b30288-0 | You are viewing documentation for version: 2.6 (latest) | Version History
Getting Started with a STM32 Host#
This guide describes how to get started developing a RS9116W application on an STM32 embedded host MCU using the WiSeConnect™ Simple Application Programming Interface (SAPI). For quick evaluation using only the EVK and a PC instead see Getting Started with PC using AT Commands.
Getting started with application development on an STM32 involves the following steps:
Download the WiSeConnect™ Software Driver Package
Choose a host MCU development board
Update the RS9116W Firmware
Connect the RS9116 EVK to the STM32 development board
Open an Example Project in the Keil IDE
Run an Example Project on the Development Kit
Download the WiSeConnect™ Software Driver Package#
Download or clone the WiSeConnect™ Software Driver Package repository from GitHub.
Choose a host MCU development board and tools#
The example projects provided with the WiSeConnect™ Software Driver Package are designed to work out-of-the-box with the STM32F411RE Nucleo-64 Development Kit from ST Microelectroncis and the Keil MDK development environment. Before continuing with this guide, download and install the Keil MDK.
The WiSeConnect™ driver software can also be run on many other embedded host MCU's. To run example projects on a Silicon Labs EFM32/EFR32 host see: Getting Started with a EFx32 Host. Details on porting the driver to other non-Silicon Labs platforms can be found in the RS9116W SAPI Porting Guide.
Update the RS9116W Firmware# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-stm32\index.html |
f1b042b30288-1 | Update the RS9116W Firmware#
When you first receive a RS9116 EVK or when upgrading to a new version of the WiSeConnect™ Software Driver Package, we recommend you update the RS9116W firmware. There are several update methods available when just getting started it is best to follow the method outlined in Updating RS9116W Firmware
Note!
Be sure to disconnect the RS9116 EVK from the host MCU board before updating the firmware using the method described in Updating RS9116W Firmware
Connect the RS9116 EVK to the STM32 MCU Development Board#
STEP 1. Connect the RS9116 EVK reset pin RST_PS to the STM32F11RE development board CN10 pin 6 to enable the STM32 to reset the RS9116.
STEP 2. Connect the STM32F411RE board to the SDIO/SPI connector of the RS9116 EVK using the 10-pin ribbon cable provided with the RS9116 EVK.
The pinout of the SPI cable is shown in the image below.
The following table summarizes the connections between the RS9116 EVK SDIO/SPI connector (J4) and the STM32F411RE development board connector (CN10).
Signal Name
RS9116 EVB (J4 - SDIO/SPI)
STM32F411 Board (CN10)
NC
10
No Connect
SPI_INTR
21
SPI_MISO
13
SPI_MOSI
15
GND
No Connect
SPI_CLK
11
VDD
GND
SPI_CS
17
NC
No Connect
STEP 3. Set the ISP switch on the RS9116 EVK to the OFF position. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-stm32\index.html |
f1b042b30288-2 | STEP 3. Set the ISP switch on the RS9116 EVK to the OFF position.
STEP 4. Connect the RS9116 EVK to a PC using the USB interface labeled POWER. Note that this connection only provides power to the EVK. There is no USB communication over this connection.
STEP 5. Connect the STM32 development board to a PC using the Mini USB connector on the STM32F411RE board.
Complete hardware details of the RS9116 EVK can be found in the RS9116 EVK User's Guide.
Power Save GPIO Connections#
The instructions above enable basic operation between the host MCU and RS9116. Some low power examples require additional GPIO configuration to enable Low Power (LP) or Ultra Low Power (ULP) operation. These details are valid for any example provided in the WiSeConnect™ SDK unless otherwise noted in the readme documentation for a particular example.
Connections for Ultra-Low Power (ULP) Operation
Signal Name
STM32F411 Board (CN10)
RS9116 EVK
Notes
UULP_2
J9 Pin 4
UULP_0 (UULP_3)
J9 Pin 5
Only use UULP_3 for RS9116 EVK v1.3 or earlier
Connections for Low Power (LP) Operation
Signal Name
STM32F411 Board (CN10)
RS9116 EVK
Notes
UULP_5
J9 Pin 4
UULP_0 (UULP_3)
J9 Pin 5
Only use UULP_3 for RS9116 EVK v1.3 or earlier
Reset Connection#
Signal Name
STM32F411 Board (CN10)
RS9116 EVK
Notes
RST_PS
J9 Pin 2 | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-stm32\index.html |
f1b042b30288-3 | RS9116 EVK
Notes
RST_PS
J9 Pin 2
An STM32 GPIO is used to reset the RS9116
Open an Example Project in the Keil IDE#
The WiSeConnect™ SDK includes a number of ready-made example projects for the STM32F411RE Nucleo-64 Development Kit and the Keil MDK development environment. A list of examples and documentation detailing the operation of each example can be found in: WiSeConnect™ Example Applications .
For the steps below, the Keil MDK development environment must be installed on the PC that is connected to the STM32F411RE development board. Refer to the Keil website for details on downloading and installing the development environment.
STEP 1. Open the Keil µVision IDE
STEP 2. Click the menu item Project > Open Project...
STEP 3. Navigate to the examples folder in the downloaded WiSeConnect™ Software Driver Package and choose the µVision project file of the example you would like to open. Every example contains a projects folder containing various project files. For example, the path to the firmware update featured example project can be found in the following path:
<SDK>/examples/featured/firmware_update/projects/firmware_update-nucleo-f411re.uvprojx.
STEP 4. Opening the project will result in a fully functional project in the IDE that can be built, run and debugged.
Run an Example Project on the Development Kit#
You can build, run and debug the newly opened example project simply using the standard toolbar and menu items in the Keil µVision IDE. Refer to the Keil documentation for more details.
For instructions to configure and use each, see Example Applications. The same information is also available in the readme.md file available with the example project source code. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-getting-started-with-stm32\index.html |
767ac231ed2a-0 | You are viewing documentation for version: 2.6 (latest) | Version History
RS9116W - WiSeConnect™#
WiSeConnect™ offers a full network offload option for embedded systems with low-end host microcontrollers running an RTOS or bare metal OS. The RS9116W connects to a host MCU using UART or SPI interfaces. A complete set of wireless, networking and security stacks run on the RS9116W device, however the networking stack can be bypassed if required. Communication with the host MCU is achieved with AT Commands, or alternately a simple binary API referred to as SAPI. Embedded products provide greater than 20 Mbps Wi-Fi application throughput with multiple operating modes including Wi-Fi Client, Wi-Fi Access Point, Simultaneous Wi-Fi Client & Access Point and Dual-mode Bluetooth.
To get started using the WiSeConnect™ SDK, follow the instructions in on one of the getting started guides below:
Getting Started with PC using AT Commands
Getting Started with EFx32 Host
Getting Started with STM32 Host
The software package is available directly in Simplicity Studio for Silicon Labs EFx32 hosts. For other MCU hosts the software package can be downloaded directly from the Silicon Labs GitHub space.
Download the latest WiSeConnect™ Software Driver Package | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-overview\index.html |
c371779707c8-0 | You are viewing documentation for version: 2.6 (latest) | Version History
AT Command Programming Reference Manuals#
The programming reference manuals listed below describe the AT-command interface and other programming details of the RS9116W. These documents should be referenced for detailed information that may not be available in the SAPI Reference.
Wi-Fi AT Command PRM#
Software architecture
Bootloader details
Host interface guide
Interface and command protocols
AT Command reference for Wi-Fi
BLE AT Command PRM#
Software architecture
Bootloader details
Host interface guide
Interface and command protocols
AT Command reference for BLE
Bluetooth Classic AT Command PRM#
Software architecture
Bootloader details
Host interface guide
Interface and command protocols
AT Command reference for Bluetooth Classic | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-programming-reference-manuals\index.html |
7488a6e0a156-0 | You are viewing documentation for version: 2.6 (latest) | Version History
WiSeConnect Release Notes#
Release notes are provided with each version of the WiSeConnect™ SDK.
WiSeConnect™ 2.6.1
WiSeConnect™ 2.6
WiSeConnect™ 2.5.2
WiSeConnect™ 2.5.1
WiSeConnect™ 2.5
WiSeConnect™ 2.4.1
WiSeConnect™ 2.4
WiSeConnect™ 2.3
WiSeConnect™ 2.0
WiSeConnect 2.6.1 Release Notes#
Last updated: September 14, 2022
Highlights#
Bug fixes
Release Details#
Item
Details
Release date
September 16, 2022
API Version (SAPI)
2.6.1 (Build 6)
Firmware Version
2.6.1.6 (Build 6)
Package Name
RS9116W.2.6.1.6
Supported RTOS
FreeRTOS
Hardware Modules
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Hardware Chipsets
Chip Revision 1.4, Chip Revision 1.5
Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.6.1 release consists of two components, as follows:
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-1 | Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release is meant only for use with designs based on RS9116 Silicon rev 1.4 (RS9116X-xxx-xxx-Bxx) and RS9116 Silicon rev 1.5 (RS9116X-xxx-xxx-Cxx).Customers using the RS9116X-xxx-xxx-Xxx parts (Silicon rev 1.3) can also upgrade to the latest firmware, however the power optimization feature macro EXT_FEAT_LOW_POWER_MODE must be disabled for revision 1.3.
Choose the firmware to match the silicon revision used in your design, as follows:
RS9116W.2.6.1.0.6.rpsRS9116X-xxx-xxx-Xxx (Silicon rev 1.3)RS9116X-xxx-xxx-Bxx (Silicon rev 1.4)
RS916W.2.6.1.0.6.rpsRS9116X-xxx-xxx-Cxx (Silicon rev 1.5)
Changes and Fixes#
Wi-Fi#
Resolved issues with DHCP renewal process when HTTP download is in progress.
Enhanced frequency offset calibration by reducing the number of iterations required. Also added checks to ensure frequency offset tuning doesn't get wrapped-around.
Resolved stability issues with static IP assignment when a duplicate IP address on the network is configured on STA.
For RSSI Query, responding with beacon avg rssi instead of last beacon RSSI.
Memory read/write support added in AT mode.
Fixed firmware stuck issue in WAP3 connection failure cases and also added changes to support WPA3-R3 certification.
Fixed issue with error code 0x0015 observed for Configuration save or Configuration Enable commands with some Opermode configurations.
Bluetooth
Fix for fragmentation issue with 1Mbps to improve BLE performance. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-2 | Fix for fragmentation issue with 1Mbps to improve BLE performance.
Fix to change BLE advertise frame Tx power by rsibt_updategaintableoffsetMaxpower.
Fix to reduce the timing for BT pairing and connection with with BT_Power_save application.
Fix for BLE disconnection with different error coes (4e08,4e22,4e3e) in AT modes.
Fix to improve BLE scan performance on 1.3 revison boards.
Fix for disconnection in audio streaming after connecting DUT to remote BLE device.
Fix to get exact response for "at+rsibt_getlocalcod?" command.
Fix for Bluetooth classic work in the coex mode of RSI_OPERMODE_WLAN_BT_DUAL_MODE.
Fix for module returning the improper remote device MTU size in the rsi_bt_app_on_spp_connect callback.
Fix for first byte missing During the spp_tx in AT_commands.
Fix for AFH map reported by HCI command HCI_Read_AFH_Channel_Map.
Fix for bluetooth AFH disabling after role switch.
Fix for SPP issues reported by automation team.
Fix for BLE TX Power is not changing for TELEC and KCC regions.
Fix for BLE SMP connection, if pairing information available, slave does not require to send pairing request.
Documentation
Updated documentation for user store configurations feature.
Updated Wi-Fi PRM with information on the commands supported in concurrent mode.
Indicating error(0xFFF8) for UDP command when wrong parameters are issued.
Added a note point in SAPI PRM that provided values for x0_ctune in calibration app.
Updated the Document by adding WPA3 new features.
Known Issues
Power save in PTA 3-Wire Co-Existence functionality requires a weak pull up to be applied to the GRANT pin. However, Beacon protection with power save is unsupported. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-3 | WiSeConnect 2.6 Release Notes#
Index#
Highlights
Release Details
Updating to this Release
New Features
Changes and Fixes
New APIs
Recommendations and New Options
Known Issues
Limitations and Unsupported Features
SDK Refactor
Terminology
Highlights#
Support for storing server IP and port in non-volatile memory
IP conflict detection support for RS9116 internal network stack
SNI (Server Name Indication) support for RS9116 silicon revision 1.4 and 1.5
Enhancements to support for logging
Enhancements to PTA 3-wire coexistence to protect beacon reception
Swyentooh and braktooth vulnerability fixes for BT/BLE
Release Details#
Item
Details
Release date
June 15, 2022
API Version (SAPI)
2.6.0 (Build 34)
Firmware Version
2.6.0 (Build 34)
Package Name
RS9116W.2.6.0.34
Supported RTOS
FreeRTOS
Hardware Modules
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Hardware Chipsets
Chip Revision 1.4, Chip Revision 1.5
Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.6 release consists of two components, as follows:
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-4 | Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release is meant only for use with designs based on RS9116 Silicon rev 1.4 (RS9116X-xxx-xxx-Bxx) and RS9116 Silicon rev 1.5 (RS9116X-xxx-xxx-Cxx). Customers using the RS9116X-xxx-xxx-Xxx parts (Silicon rev 1.3) can also upgrade to the latest firmware, however the power optimization feature macro EXT_FEAT_LOW_POWER_MODE must be disabled for revision 1.3.
Choose the firmware to match the silicon revision used in your design, as follows:
RS9116W.2.6.0.0.34.rpsRS9116X-xxx-xxx-Xxx (Silicon rev 1.3)RS9116X-xxx-xxx-Bxx (Silicon rev 1.4)
RS916W.2.6.0.0.34.rpsRS9116X-xxx-xxx-Cxx (Silicon rev 1.5)
This release includes bug-fixes, enhancements, relevant AT command updates, new SAPI features, and firmware. Most of the new features have associated APIs, which are available in the latest SAPI implementation only. It is strongly recommended to upgrade SAPI and Firmware together.
New Features#
Wi-Fi#
Support for storing server IP and port in non-volatile memory
IP Conflict detection support for RS9116 internal network stack
SNI (Server Name Indication) support for RS9116 silicon revision 1.4 and 1.5
Enhancements to PTA 3-Wire coexitence to protect beacon reception
Bluetooth - Common#
Swyentooh and braktooth vulnerability fixes for BT/BLE
General#
Enhancements to support for logging | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-5 | General#
Enhancements to support for logging
Wi-Fi interoperability bug fixes
Changes and Fixes#
rsi_recv timeout granularity changed from 1s to 10 ms.
Fix for BLE disconnection and BLE SMP connection issues in example applications
Fix for Wi-Fi reconnections due to improper handling of isolated cipher mismatch event
Fix in example application for SonyMDR headset glitch issue
Fix for glitches and audio pauses for AirPods Pro, Sennheiser, Jabra Elite and Mi Earphones while connected to Wi-Fi
Fix for the issue where at+rsi_scan return invalid channel in case of reconnection with 5GHz band AP
Fix for HTTPS file download issue in EAP-TLS network
New APIs#
For a complete list of new APIs, see SAPI Changelog
Recommendations and New Options#
Wi-Fi#
To ensure graceful handling during asynchronous TCP closures from a peer, enable the opermode parameter ext_tcp_ip_feature_bit_map[16]
Enable aggregation using the opermode parameter feature_bit_map[2]
To avoid TCP disconnects during a rejoin, set TCP retransmission count to >= 30
To make a connection more robust for low throughput applications in busy networks, disable high MCS rates. For example, in a congested wireless envionment, a Smart Lock may benefit by disabling MCS6 and MCS7.
To restart the RS9116, the application should call rsi_driver_deinit() followed by rsi_driver_init() and rsi_device_init(). For OS cases, additionally call rsi_task_destroy(driver_task_handle) to delete the driver task before calling rsi_driver_deinit() and create again after rsi_device_init() using rsi_task_create(). | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-6 | Register the 'Join Fail Callback' function each time join is called. This is required because if a join fails, the callback is deregistered. Failure to register the callback may stop scan working correctly on a rejoin failure.
BT/BLE#
In BLE, the recommended range of the BLEConnection Interval is as follows:Power Save (BLE Only) - 100 ms to 1.28 sBT Classic + BLE Dual Mode is >= 200 msWi-Fi + BLE coex - 30 ms to 250 ms
In BLE during Connection, the configuration of Scan Interval and Scan Window with the same value is not recommended
In BT Classic, the recommended Sniff Interval configuration during powersave is limited to 100 ms (<= 100).
In BLE, if a device is acting as Central, the scan window (in set_scan_params() and create_connection() APIs) must be less than the existing Connection Interval.
In BLE mode, if scanning and advertising is in progress, and the device subsequently connects and moves to the central role, scanning and advertising stops. To further establish connection to another peripheral device or to a central device, the application must initiate advertising and scanning again.
Device powersave must be disabled prior to BT init and de-init.
Co-Existence#
For concurrent Wi-Fi + BLE, and while a Wi-Fi connection is active, we recommend setting the ratio of the BLE scan window to BLE scan interval to 1:3 or 1:4.
Wi-Fi + BLE AdvertisingAll standard advertising intervals are supported. As Wi-Fi throughput is increased, a slight difference in on-air advertisements compared to configured intervals may be observed.BLE advertising is skipped if the advertising interval collides with Wi-Fi activity. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-7 | Wi-Fi + BLE scanningAll standard scan intervals are supported. For better scan results, we recommend setting the ratio of the BLE scan window to BLE scan interval to 1:3 or 1:4.BLE scanning will be stopped for intervals that collide with Wi-Fi activity.
Wi-Fi + BLE Central/Peripheral ConnectionsAll standard connection intervals are supported.For a stable connection, use optimal connection intervals and max supervision timeout in the presence of Wi-Fi activity.
Wi-Fi + BLE Central/Peripheral Data TransferTo achieve higher throughput for both Wi-Fi and BLE, use medium connection intervals, such as 45 to 80 ms with maximum supervision timeout.Ensure Wi-Fi activity consumes lower intervals.
For Wi-Fi + BT + BLE, Wi-Fi + BT, Wi-Fi + BLE operating modes, connect Wi-Fi before BT/BLE connections to ensure seamless, stable connection for all 3 protocols.
For Wi-Fi + BT + BLE, Wi-Fi + BT, Wi-Fi + BLE operating modes, if BT/BLE needs to be connected before a Wi-Fi connection, use with high supervision timeout and high connection interval for BLE and high sniff interval for BT, to ensure seamless, stable connection. This configuration also ensures a stable BT/BLE connection when Wi-Fi connects/disconnects/rejoins.
Wi-Fi + BLE Central/Peripheral Data Transfer
System#
For User Store configuration and Configuration Save, do not enable power save or save it as a configuration. If power save is enabled and saved as a configuration, upon boot up, the RS9116 will boot with the saved configuration and will go to powersave without any indication to the host.
Set the compiler optimization level to O0 in project settings for IDE (KEIL). | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-8 | Set the compiler optimization level to O0 in project settings for IDE (KEIL).
Memory configuration must be 384K for BT/BLE and co-ex operating modesUsage of low power flash mode bit (bit 19 in extended customer feature bitmap). Enable this bit for ultra low power standby associated scenarios. This results in about 20µA lower Wi-Fi standby associated current consumption.
Memory Configuration in SAPI functions: The default memory configuration is 384K. The memory configuration can be changed to 256/320/384kB by changing the macros defined in the following files:In rsi_wlan_config.h : RSI_EXT_CUSTOM_FEATURE_BIT_MAP EXT_FEAT_256K_MODE or EXT_FEAT_320K_MODE or EXT_FEAT_384K_MODEIn rsi_common.c : rsi_uint32_to_4bytes(rsi_opermode->ext_custom_feature_bit_map, (EXT_FEAT_256K_MODE (or) EXT_FEAT_320K_MODE (or) EXT_FEAT_384K_MODE | RSI_EXT_CUSTOM_FEATURE_BIT_MAP));
Apply Opermode commands in AT mode correctly. Using the wrong opermode may lead to unspecified behavior.
Set the recommended Power Save Profile (PSP) type to Enhanced Max PSP.
During firmware updates, powersave operation should be disabled.
For high throughput applications, powersave operation should be disabled.
The application must set the real-time clock with correct timestamp when the feature is enabled before establishing a TLS connection.
The socket select and socket receive timeout must be at least 1 second. A timeout value under 1 second is not supported.
For more details, see 'Configuration parameters' in the SAPI Reference Manual.
Known Issues#
Network Stack#
DHCP renewal during HTTP download may fail, this may cause disconnection. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-9 | Network Stack#
DHCP renewal during HTTP download may fail, this may cause disconnection.
Sometimes during a TLS handshake, ECC curve parameters may be incorrectly generated resulting in connection failure with BBD2 error. However, this recovers in the next attempt.
MQTT disconnects during firmware update when power save is enabled. Disable power save during firmware update and re-enable on update completion.
All GCM-based cipher suites are implemented in software and have limited performance.
The recommended MQTT publish payload is 1 kBytes.
If HTTP server functionality is enabled, do not use port 80 for the MQTT client.
Randomize the client port if using rapid connect/disconnect of the MQTT session on the same client port with powersave.
Secure TLS renegotiation is not supported in the embedded networking stack.
IPv6 support is not available in this release.
Wi-Fi#
WPA3 known issuesConnection takes about 3-4 secondSAE H2E (Hash to Element) is not supportedTransition disable indication is not supportedPMK SA caching is not supported
If the station performs a scan in concurrent mode (Wi-Fi STA+AP), stations connected to the AP may be disconnected. Enable AP after STA connection is completed.
Issue observed with WPA2 Enterprise Connectivity using Microsoft RADIUS Server.
If background scan is enabled along with custom feature bit map bit (8) configuration of the DFS channel support, issues may occur in obtaining an IP address for the Wi-Fi STA.
In fast PSP, configuration socket close is observed in full duplex communication in long duration tests.
PTA 3-wire co-existence does not work with powersave. However, if a weak pull up is applied to the GRANT pin, PTA 3-wire functionality will work with powersave. Details can be found in application notes.
BT/BLE#
SPP as MASTER connection doesn't work in AT/Binary mode | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-10 | BT/BLE#
SPP as MASTER connection doesn't work in AT/Binary mode
In AT Mode for SPP Transfer the first byte is missing
BT/BLE User Gain table APIs don't work for Korea and Japan region
In the configuration of WLAN connection, BT A2DP Streaming and BLE Slave connection with SMP mode, BLE disconnections are observed
Wake on Wireless is not supported for BLE.
BT-HID may not interoperate with Apple devices.
In Wi-Fi + BT/BLE Co-Ex mode, high Wi-Fi broadcast traffic might cause BT/BLE disconnections.
In Wi-Fi + BT mode when there is continuous Wi-Fi data, you might observe BT not re-connecting to remote after disconnection.
BT-A2DP may not interoperate with some headsets.
For BLE, dual role scenario issues may occur when connecting as a central when the peripheral is advertising. Central connections can be made after peripheral connections are established and advertising stops.
A BLE disconnection will occur if both the peer and RS9116 already have bond info and the RS9116 initiates security as part of BLE secure connections. To workaround this issue, the application should not initiate a security request if it already has bond info.
A2DP music streaming glitches may be observed if a Wi-Fi download is in progress at the same time.
Co-Existence#
After powersave is enabled in co-ex mode, radio_init() must be called to turn off powersave.
In Wi-Fi + BLE mode:BLE may disconnect when the supervision timeout is configured to less than 16 seconds.WPS does not work.
In Wi-Fi + BLE / BLE only modes:For SPI as host interface, continuous BLE Tx notification may cause the host interface to hang needing a hardware reset. The issue is not seen with discrete burst BLE data.When Wi-Fi disconnects, a BT/BLE reconnection issue is observed.
Interoperability# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-11 | Interoperability#
Disconnection may occur in Wi-Fi client mode if an AP does not acknowledge QoS null frames with powersave configured.
Under some scenarios, the RS9116 may not send unicast probe requests if the access point does not send beacons as expected. This may result in disconnection from the AP.
System#
Chip Revision 1.3 doesn't support Low power mode optimization using bit setting defined by EXT_FEAT_LOW_POWER_MODE, setting this results in hang issue.
Sometimes the RS9116 enters powersave mode before the configured monitor interval for inactivity when co-ex is configured.
Wake on Wireless support has only been tested for the UART AT command interface.
Powersave without RAM retention does not work when the SPI interface is used.
The FTP client application does not work with EFx32/STM32 when an RTOS is used.
The HTTP OTA update application does not work with EFR32 and EFM32 when an RTOS is used.
Firmware update does not work for the EFM32 platform.
Limitations and Unsupported Features#
Wi-Fi/Network Stack#
AMSDU transmit is not supported.
Fragmentation is not supported.
AMSDU's within AMPDU is not supported.
Currently, the RS9116 does not support the radio measurement requests feature of CCX V2
802.11k is not supported
Short GI is not supported
40 MHz bandwidth for both the 2.4 & 5 GHz band is not supported.
802.11j channels less than 16 are not supported.
The USB host interface and USB powersave are not supported.
In AT mode, the total MQTT command length (apart from MQTT publish) should not exceed 150 bytes. This includes at+rsi (start of command) to (end of command)\r\n. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-12 | Configure MQTT_VERSION in rsi_mqtt_client.h based on the server configuration; only version 3 and 4 are supported.
3xTLS connections or 1xTCP and 2xTLS connection, connections are supported concurrently in Wi-Fi only mode.
TLS curve IDs supported are 15-28. TLS handshake with 3rd party clients depends on the TLS curve.
BT/BLE#
BT A2DP is only supported for RS9116 silicon revision 1.5.
BT sniff mode does not work if BT multiple slaves feature is enabled.
For BLE, if the connection is established with a small connection interval (<15 ms), simultaneous roles are not supported (i.e., Central/Peripheral + Advertising/Scanning).
A maximum of 2 concurrent BLE connections are supported; the connections can be either a connection to two peripheral devices or to 1 central and 1 peripheral device.
For BT Classic, only 1 connection is supported at any time.
BLE slave latency value is valid up to 32 only.
BT-A2DP encoder is not supported in the firmware.
BT-A2DP not supported in AT mode.
Co-Existence#
In Wi-Fi + BLE mode, if BLE scan interval and window have the same value, then there will be issue in making successful Wi-Fi connection.
For AT commands, Wi-Fi + BT + BLE (Opermode 9), BT + BLE (Opermode 8) do not work.
Wi-Fi STA + BT + BLE multiprotocol use cases require a detailed understanding of use cases and associated configurations. Contact Silicon Labs support for additional details.
Wi-Fi AP + BLE, Wi-Fi AP + BT & Wi-Fi AP + BT + BLE modes are not supported.
WiSeConnect 2.5.2 Release Notes#
Last updated: April 13, 2022
Highlights#
Issue fixes
Release Details#
Item | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-13 | Highlights#
Issue fixes
Release Details#
Item
Details
Release date
April 13, 2022
API Version (SAPI)
2.5.2 (Build 4)
Firmware Version
2.5.2.0.4 (Build 4)
Package Name
RS9116W.2.5.2.0.4
Supported RTOS
FreeRTOS
Hardware Modules
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Hardware Chipsets
Chip Revision 1.4, Chip Revision 1.5
Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.5.2 release consists of two components
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release contains bug-fixes and firmware binary updates. It is strongly recommended to update SAPI and firmware together.
Changes and Fixes#
Fix for Bluetooth SPP Rx latency with SDIO as host interface
Fix for Bluetooth host application freeze issue with SDIO as host interface
Documentation updates to address following issuesSNTP Error BB08BT Classic and BLE PER Stats command responses are NULL
Known Issues#
PTA 3-Wire is not supported with power save being enabled.
WiSeConnect 2.5.1 Release Notes#
Last updated: March 29, 2022
Highlights#
PTA 3-Wire Co-Existence support in Wi-Fi only mode with Thread protocol
Issue fixes
Release Details#
Item
Details
Release date
March 29, 2022
API Version (SAPI)
2.5.1 (Build 5) | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-14 | API Version (SAPI)
2.5.1 (Build 5)
Firmware Version
2.5.1.5 (Build 5)
Package Name
RS9116W.2.5.1.5
Supported RTOS
FreeRTOS
Hardware Modules
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Hardware Chipsets
Chip Revision 1.4, Chip Revision 1.5
Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.5.1 release consists of two components
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release contains bug-fixes and firmware binary updates. It is strongly recommended to update SAPI and firmware together.
Changes and Fixes#
PTA 3-Wire Co-existence support in Wi-Fi only mode with Thread protocol
Fix for rsi_timer_left() to return the remaining time for expiry instead of total time expired so far
Fix for low transmit power issue reported on latest AA0 modules
Fix for firmware version showing differently in the package and in the software
Fix for configuration of SPI_INTR to active low
Fix for regulator voltages (VOUTLDOAFE, UULP_VOUTSCDC) not matching data sheet specifications
Fix for HTTP OTAF upgrade issue when done with corrupt firmware in loop
Fix for EAP TLS certificate loading issue in TCP/IP bypass enabled mode
Fix for SNTP BB08 error
WiSeConnect 2.5 Release Notes#
Index#
Highlights
Release Details
Updating to this Release
New Features
Changes and Fixes
New APIs
Recommendations and New Options
Known Issues | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-15 | New Features
Changes and Fixes
New APIs
Recommendations and New Options
Known Issues
Limitations and Unsupported Features
SDK Refactor
Terminology
Highlights#
Support for RS9116 chip revision 1.5
WPA2 Security Enhancements support
WPA3 Personal support for Station Mode
Support for Enhanced MaxPSP in Co-Ex Mode
Support for FAST PSP
PTA 3-Wire Co-existence Support for Wi-Fi as PTA Master
BT/BLE User Gain API support
WRECK Vulnerability fixes
FragAttacks vulnerability Fixes
SDIO Interface support
A2DP Source support with Co-existence
EFM32 (Silicon Labs MCU SLSTK3701A) platform support
Release Details#
Item
Details
Release date
December 31, 2021
API Version (SAPI)
2.5.0 (Build 26)
Firmware Version
2.5.0 (Build 26)
Package Name
RS9116W.2.5.0.26
Supported RTOS
FreeRTOS
Hardware Modules
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Hardware Chipsets
Chip Revision 1.4, Chip Revision 1.5
Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.5 release consists of two components, as follows:
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-16 | Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release is meant only for use with designs based on RS9116 Silicon rev 1.4 (RS9116X-xxx-xxx-Bxx) and RS9116 Silicon rev 1.5 (RS9116X-xxx-xxx-Cxx).Customers using the RS9116X-xxx-xxx-Xxx parts (Silicon rev 1.3) can also upgrade to the latest firmware. However, you will have to disable the power optimization feature enabling macro EXT_FEAT_LOW_POWER_MODE.
Choose the firmware to match the silicon revision used in your design, as follows:
RS9116W.2.5.0.26.rpsRS9116X-xxx-xxx-Xxx (Silicon rev 1.3)RS9116X-xxx-xxx-Bxx (Silicon rev 1.4)
RS916W.2.5.0.26.rpsRS9116X-xxx-xxx-Cxx (Silicon rev 1.5)
This release has bug-fixes, enhancements, relevant AT command updates, new SAPI features, and firmware. Most of the new features have associated APIs, which are available in the latest SAPI implementation only. It is strongly recommended to upgrade SAPI and Firmware together.
New Features#
Wi-Fi#
WPA2 Security Enhancements
WPA3 Personal Support for Station Mode
Support for Enhanced MaxPSP in Co-Ex Mode
Support for FAST PSP
WRECK Vulnerability Fixes
FragAttacks Vulnerability Fixes
PTA 3-Wire Co-Existence Support in Wi-Fi only mode (with external Zigbee and BLE)
Bluetooth - Common#
BT/BLE User Gain API support
Bluetooth - Classic# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-17 | Bluetooth - Common#
BT/BLE User Gain API support
Bluetooth - Classic#
Support for BT Advanced Audio Distribution Profile Source in Co-Ex mode. An example application project is included for the RT595 host platform. This is supported for Chip Revision 1.5 only.
Power Save#
None
General#
Support for RS9116 chip revision 1.5
Support for SDIO interface
Logging Infrastructure support for SAPI logging
802.11b Tx gain table improvements for chip revision 1.5 QMS
Chip revision 1.5 B00 certified FCC/ETSI/TELEC gain tables included
RS9116X-DB00-CCX-BXX certified TELEC gain tables included
TELEC certified
Support for examples on EFM32 (Silicon Labs MCU SLSTK3701A) platform for SDIO interface only
Certified gain tables for FCC/IC, CE and TELEC are included in the release package in the folder: .../resources/gain_tables
Changes and Fixes#
Fix for BT connectivity issue with HID profile with Windows 10 PC
New API, which allows destroying a driver task before driver de-initialization to facilitate clean termination
Fix for WLAN scan issue with error code 3 in some of the 1.3-based AA0 modules(RS9116X-SB00-AAX-XXX)
Fix for Module not responsive after few iterations of SPP profile data transfer in AT mode
Fix for SPP throughput issue
Fix for UDP Server socket issue in AP mode
New APIs
For a complete list of new APIs, see SAPI Changelog
Recommendations and New Options#
Wi-Fi#
Enable bit 16 of the 'Extended TCP IP Feature' bit map in opermode command for all Wi-Fi socket operations from host to ensure graceful handling during asynchronous closures from peer.
Enable aggregation (bit 2 of feature_bit_map) in opermode. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-18 | Enable aggregation (bit 2 of feature_bit_map) in opermode.
TCP retransmission count value should be 30 or higher, so that the TCP does not disconnect while the rejoin happens.
For low throughput applications, such as smart lock, disabling the highest MCS rates, such as MCS7 and MCS6 might help reducing packet retransmissions and ensure robust connection during heavy interference.
To restart the RS9116, the application needs to call rsi_driver_deinit() followed by rsi_driver_init() and rsi_device_init(). For OS cases, additionally call rsi_task_destroy(driver_task_handle) to delete the driver task before calling rsi_driver_deinit() and create again after rsi_device_init() using rsi_task_create().
Register 'Join Fail Callback' function every time when join is called, as in the rejoin failure path the callback is deregistered. If not done, this may result in scan not working on rejoin failure.
BT/BLE#
In BLE, the recommended range of the connection interval is as follows:Power Save (BLE Only) - 100 ms to 1.28 sBT Classic + BLE Dual Mode is >= 200 msWi-Fi + BLE coex - 30 ms to 250 ms
In BLE during connection, the configuration of scan interval and scan window with the same value is not recommended.
In BT Classic, the recommended sniff interval configuration during powersave is limited to 100 ms (<= 100).
In BLE, if a device is acting as central, the scan window (in set_scan_params and create_connection command) must be less than the existing connection interval.
In BLE mode, if scanning and advertising is in progress and subsequently gets connected and moves to the central role, scanning and advertising stops. To further establish connection to another peripheral device or to a central device, the application should - give a command for starting advertising and scanning again. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-19 | Device Power save need to be disabled before BT init and de-init.
Co-Existence#
For Wi-Fi + BLE, during Wi-Fi connection, lesser BLE scan Window and larger BLE scan Interval are recommended (1:3 or 1:4).
Wi-Fi + BLE AdvertisingAll advertising intervals are supported, as per the BT Spec. If the Wi-Fi transactions are more, you may see a slight difference in on-air advertisements compared to the configured intervals.BLE Advertising will be stopped for intervals that collide with Wi-Fi activity.
Wi-Fi + BLE scanningAll scan intervals are supported as per BT Spec. For better scan results, use scan-window and scan interval in 1:3 or 1:4 ratio when the Wi-Fi scan activity is present.BLE scanning will be stopped for intervals that collide with Wi-Fi activity.
Wi-Fi + BLE Central/Peripheral ConnectionsAll connection intervals are supported as per BT Spec.For a stable connection, use optimal connection intervals and max supervision timeout in the presence of Wi-Fi activity.
Wi-Fi + BLE Central/Peripheral Data TransferTo get better throughputs in both Wi-Fi and BLE, use medium connection intervals, such as 45 to 80 ms with maximum supervision timeout.Ensure Wi-Fi activity consumes lesser intervals.
For Wi-Fi + BT + BLE, Wi-Fi + BT, Wi-Fi + BLE operating modes, connect Wi-Fi ahead of BT/BLE connections to ensure seamless, stable connection for all 3 protocols.
For Wi-Fi + BT + BLE, Wi-Fi + BT, Wi-Fi + BLE operating modes, if BT/BLE needs to be connected ahead of Wi-Fi connection, use with high supervision timeout and high connection interval for BLE and high sniff interval for BT, to ensure seamless, stable - connection. This configuration will also ensure a stable BT/BLE connection when Wi-Fi connects/disconnects/rejoins.
Wi-Fi + BLE Central/Peripheral Data Transfer
System# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-20 | Wi-Fi + BLE Central/Peripheral Data Transfer
System#
For User Store configuration and Configuration Save, do not enable power save or save it as a configuration. If power save is enabled and saved as a configuration, upon boot up, the module will come up with the saved configuration and will go to power save without any indication to the host.
Set Optimization level to O0 in project settings for IDE (KEIL).
Memory Configuration must be 384K for BT/BLE and Co-Ex Operating ModesUsage of Low Power Flash mode bit (Bit 19 in Extended customer feature bitmap). Enable this bit for ultra low power standby associated scenarios. This results in about 20µA lower Wi-Fi standby associated current consumption.
Memory Configuration in SAPI functions: The default memory configuration is 384K. You can configure it to 256/320/384kB by changing the macros defined in the below two files:In rsi_wlan_config.h : RSI_EXT_CUSTOM_FEATURE_BIT_MAP EXT_FEAT_256K_MODE or EXT_FEAT_320K_MODE or EXT_FEAT_384K_MODEIn rsi_common.c : rsi_uint32_to_4bytes(rsi_opermode->ext_custom_feature_bit_map, (EXT_FEAT_256K_MODE (or) EXT_FEAT_320K_MODE (or) EXT_FEAT_384K_MODE | RSI_EXT_CUSTOM_FEATURE_BIT_MAP));
Apply opermode commands in AT mode correctly. The wrong opermode in some cases might lead to unspecified behavior.
Set the recommended Power Save Profile (PSP) type to Enhanced Max PSP.
Disable power save during firmware upgrade and re-enable on upgrade completion.
Disable power save for high throughput applications.
The application needs to ensure that it sets RTC with correct timestamp when the feature is enabled before establishing the SSL connection. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-21 | Timeout value should be minimum 1 second for socket select and socket receive calls. Timeout value less than 1 second is not currently supported.
For more details, see 'Configuration parameters' in the SAPI Reference Manual.
Known Issues#
Network Stack#
Sometimes during the SSL Handshake, the generated ECC curve parameters are incorrect, resulting in connection failure with BBD2 error. However, this recovers in the next attempt.
MQTT disconnects during firmware upgrade using OTAF, when power save is enabled. Disable power save during firmware upgrade and re-enable on upgrade completion.
Newly Added GCM Based Strong Cipher Suites will have performance issues as Hardware support is not available in the current platform.
Recommended MQTT Publish payload is 1 KB.
If the HTTP Server is configured in the module, MQTT client port should not be port configured on port 80.
Randomize the client port if using rapid connect/disconnect of the MQTT session on the same client port with the power save.
Secure SSL Renegotiation not supported in Embedded Networking Stack.
IPv6 support is not available in this release.
Wi-Fi#
WPA3 known issuesConnection takes about 1 secondSAE H2E (Hash to Element) is not supportedTransition disable indication is not supportedPMK SA caching is not supported
If the station performs the scan in concurrent mode (Wi-Fi STA+AP), it is possible for stations connected to the AP to get disconnected. Enable AP after STA connection is completed.
Issue observed with WPA2 Enterprise Connectivity using Microsoft RADIUS Server.
If BG Scan is enabled along with custom feature bit map bit (8) configuration of the DFS channel support, issues may occur in getting IP address for the Wi-Fi STA.
In FAST PSP, a configuration socket close is observed in full duplex communication in long duration tests.
BT/BLE#
Wake on Wireless not supported for BLE. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-22 | BT/BLE#
Wake on Wireless not supported for BLE.
BT-HID might not inter-operate with Apple devices.
In Wi-Fi + BT/BLE Co-Ex mode, high Wi-Fi broadcast traffic might cause BT/BLE disconnections.
In Wi-Fi + BT mode when there is continuous Wi-Fi data, you might observe BT not re-connecting to remote after disconnection.
BT-A2DP interoperability issue might be observed with some headsets.
For BLE, dual role scenario issues might occur when connecting as central if the advertising is also going out for the peripheral role. Central connections can be made after the peripheral connections are established and advertising is stopped.
BLE disconnection is observed if both peer and module already have bond info and module initiating security as part of BLE secure connections. A possible workaround in the application is not to initiate a security request if the bond information is already available.
LMP timeout BLE disconnection observed with latest Realme mobile handsets.
Some of the A2DP music streaming glitches are observed if the Wi-Fi download is in progress at the same time.
Issue with EDR-3DH5 packet reception, where in bit error rate of more than 50% is observed.
Co-Existence#
In co-ex Mode if power save is enabled, it stays in enabled state even after Wi-Fi disconnection. Disable power save after every radio_init() and enable it when intended by application.
BLE may disconnect with Wi-Fi + BLE configuration and Wi-Fi continuous data transfer when the low BLE supervision timeout is configured. When the supervision timeout is configured with the value of 16 seconds, no disconnections are observed.
WiFi + BLE mode WPS is not working.
Wi-Fi +BLE/BLE only mode: For SPI as host interface, continuous BLE TX notification might cause the host interface to hang needing a hardware reset. The issue is not seen with discrete burst BLE data. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-23 | In Wi-Fi + BT/BLE configuration with Wi-Fi disconnects, BT/BLE reconnection issue is observed (see the earlier section 'Recommended Configurations and Application Development options' in this document).
Interoperability#
QoS null frames indicating going to power save if not acknowledged by AP may cause AP not to sync with the power save state, resulting in possible disconnections.
If 3rd party access points are periodically not sending beacons, in some scenarios unicast probe requests are not sent from the module, as expected, which might result in disconnections.
System#
Chip Revision 1.3 doesn't support low power mode optimization using bit setting defined by EXT_FEAT_LOW_POWER_MODE, setting, which results in hang issue.
Sometimes the module goes to power save before the configured monitor interval for inactivity whenn Co-Ex mode is configured.
Wake on Wireless support is tested only for UART AT command interface.
Power save without RAM retention is not working for the SPI interface.
FTP Client application is not working with EFx32/STM32 in the OS scenario. The demo app to be tested only for non-OS scenario.
HTTP OTAF Application is not working with EFR32 and EFM32 in OS scenario. The demo app to be tested only for Non-OS scenario on EFR32.
Firmware upgrade for both OS and non-OS scenarios is not working for EFM32 application.
Limitations and Unsupported Features#
Wi-Fi/Network Stack#
AMSDU TX is not supported.
Fragmentation is not supported.
AMSDU's within AMPDU is not supported.
Currently, the module does not support Radio Measurement Requests feature of CCX V2
802.11k is not supported
Short GI is not supported
40 MHz bandwidth for both 2.4 & 5 GHz band is not supported. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-24 | 40 MHz bandwidth for both 2.4 & 5 GHz band is not supported.
802.11J channels less than 16 are not supported.
USB host interface and USB Power save are not supported.
Total MQTT Command Length, apart from MQTT Publish, should not exceed 150 bytes. This includes at+rsi (start of command) to (end of command)\r\n.
Configure MQTT_VERSION in rsi_mqtt_client.h based on the server configuration; only version 3 and 4 are supported.
3xSSL connections or 1xTCP and 2xSSL connection, connections are supported concurrently in Wi-Fi only mode.
SSL Curve IDs supported are 15-28. SSL handshake with 3rd party clients depends on the SSL Curve ID.
BT/BLE#
BT A2DP is supported on chip version 1.5 only
BT Sniff mode does not work if BT multiple slaves feature is enabled.
For BLE, if the connection is established with a small connection interval (< 15 ms), simultaneous roles (i.e., Central/Peripheral + Advertising/Scanning) are not supported.
BLE maximum 2 concurrent connections are supported, which can be either a connection to two peripheral devices or to 1 central and 1 peripheral device.
For BT Classic, only 1 connection is supported at any time
BLE Slave latency value is valid up to 32 only.
BT-A2DP encoder is not supported in the firmware
BT-A2DP not supported in AT mode
Co-Existence#
In Wi-Fi + BLE during Wi-Fi connection, if both BLE scan interval and window are the same, an issue will occur in successfully making the Wi-Fi connection. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-25 | For AT commands, Wi-Fi + BT + BLE (Opermode 9) B + BLE (Opermode 8) are not working. However, BT, Wi-Fi + BT modes (Opermode 5) works fine. Also, all combinations work fine with SAPI.
Wi-Fi STA + BT + BLE multiprotocol cases require detailed understanding of use cases and associated configurations. Contact Silicon Labs support for more details.
Wi-Fi AP + BLE, Wi-Fi AP + BT & Wi-Fi AP + BT + BLE modes are not supported.
SDK Refactor#
The SDK folder structure and names were significantly changed in the 2.4 release. For detailed information, see SAPI Changelog
WiSeConnect 2.4.1 Release Notes#
Last updated: September 10, 2021
Highlights#
FragAttack vulnerability fixes
Wi-Fi Interoperability issue fixes
Release Details#
Item
Details
Release date
September 1, 2021
API Version (SAPI)
2.4.1 (Build 16)
Firmware Version
2.4.1.0.16 (Build 16)
Package Name
RS9116W.2.4.1.16
Supported RTOS
FreeRTOS
Hardware Modules/Chipsets
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.4.1 release consists of two components
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release has bug-fixes and Firmware. It is strongly recommended to upgrade SAPI and Firmware together. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-26 | Changes and Fixes#
Fix for FragAttack Vulnerabilities
Fix for issues on Swyentooth Vulnerability fixes
Fix for few Wi-Fi interoperability issues with certain Access Points
Fix for issue in BLE local attribute setting, when notification not enabled in remote, resulting in error 4046
Fix for issue in AP mode, switching to 5 GHz band results in 0x5B error
Fix for UDP Asynchronous socket not storing and providing remote IP and Port information
Fix for Wi-Fi low RF transmit power output issue for AA0 modules
Fix for ping failure after reconnection to AP in concurrent mode
Fix for HTTP OTAF upgrade failing in subsequent iterations if first iteration fails due to network connections resulting in 0xBBED error
Fix for issue with BLE connection 2nd iteration onwards after connect/disconnect when remote device is advertising as connectable
Fix for issue of BT disconnection with continous SPP_rx traffic, sometime due to LMP timeout
Known Issues#
FragAttack Vulnerability CVE-2020-24588: Aggregation Attack (accepting non SPP A-MSDU frames) is not addressed in this release, as this needs a change in specification
FragAttack Vulnerability CVE-2020-26146: Aggregation Attack (reassemble fragments with non-consecutive packet numbers) is not addressed in this release
Workarounds#
CC0/CC1 Host Interface Detection at Low Temperatures#
One or more of the serial host interfaces of RS9116 CC0/CC1 modules may fail to respond to host detection at ambient temperatures lower than approximately -20 degC.
Execute the following sequence of commands to adjust the module calibration to workaround this issue.
1
#define BURN_XO_FAST_DISABLE
rsi_wireless_init
// Set the operating mode of the module
rsi_wlan_radio_init
// Set the operating band and initialize the module
rsi_calib_write | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-27 | // Set the operating band and initialize the module
rsi_calib_write
(BURN_INTO_FLASH
, BURN_XO_FAST_DISABLE
// Trigger the calibration write process to update the
// information in flash and wait for a response from the firmware.
Note!
The workaround must be executed at room temperature, ~25 degC.
The command sequence must be executed once ONLY.
Ensure the power supply to the module is stable while issuing commands.
The workaround is needed for existing products/boards already mounted with CC0/CC1 modules only.
Once executed, the module must be power-cycled before it can be used for normal operation.
WiSeConnect 2.4 Release Notes#
Index#
Highlights
Release Details
Updating to this Release
New Features
Changes and Fixes
New APIs
Recommendations and New Options
Known Issues
Limitations and Unsupported Features
SDK Refactor
Terminology
Highlights#
Azure and AWS cloud connectivity support
SweynTooth vulnerabilities fixes
Strong cipher suite support
Co-Existence Algorithm Enhancements
EN 300 328 v.2.2.2 certification support
TELEC certification support
Wi-Fi interoperability fixes and enhancements
Crystal calibration support (Needed for RS9116 QMS)
Significant reorganization and refactoring of the SDK
Integrated support for EFR32MG21 hosts and Simplicity Studio
Release Details#
Item
Details
Release date
June 30, 2021
API Version (SAPI)
2.4.0 (Build 36)
Firmware Version
2.4.0 (Build 36)
Package Name
RS9116W.2.4.0.36
Supported RTOS
FreeRTOS
Hardware Modules/Chipsets
QMS, B00, C00, CC1, AB0, AB1, AA0, AA1
Operating Modes Supported | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-28 | Operating Modes Supported
Wi-Fi STA, Wi-Fi AP, Wi-Fi STA+BLE
Additional Operating Modes Supported (Beta Quality)
Wi-Fi STA+BT, Wi-Fi STA+BT+BLE
Updating to this Release#
RS9116W 2.4 release consists of two components
Firmware - RS9116 Firmware Binary
SAPI Library - SAPI Library runs on Host
This release has bug-fixes, enhancements, new SAPI features and Firmware. Most of the new features have associated APIs, which are available in the latest SAPI implementation only. It is strongly recommended to upgrade SAPI and Firmware together.
New Features#
Wi-Fi#
Azure support for cloud connectivity
AWS support for cloud connectivity
Support for dynamic switching between AP and STA mode of operation (see config_feature_bit_map[16])
Support for loading certificate without requiring a reboot of the chip
Configurability option for disabling transmit Data rates MCS5, MCS6 and MCS7
Support for stronger cipher suites
Support for enhanced max-PSP mode for better interoperability, see config_feature_bit_map[26] and refer to API rsi_wlan_power_save_profile(). This PSP type is supported for STA-only mode.
Enhancements for better interoperability. Keep alive configuration, graceful closure of previous WLAN connections.
Enhancements to Wi-Fi Auto Rate adaptation algorithm
Enhancements to Wi-Fi + BLE Co-Existence support
Improvements to Wi-Fi + BLE provisioning examples
Bluetooth - Common#
Resolution to SweynTooth family of BT vulnerabilities
Bluetooth - Classic#
Support for BT Advanced Audio Distribution Profile Source (BT alone mode only). Example Application project included for RT595 host platform
Power Save#
Fixes for functional issues in power save mode at high temperature, 85°C
General# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-29 | Fixes for functional issues in power save mode at high temperature, 85°C
General#
WLAN EN 300 328 v.2.2.2 ETSI Certification Compliance support added for the following modules and SoC Versions: B00 1.4, QMS 1.3, QMS 1.4, CC0/CC1 1.3, CC0/CC1 1.4, and AA0/AA1 1.3
Certified gain tables are added for these modules for different antennas, which can be configured using the user gain Table API for Wi-Fi and rsi_bt_set_antenna_tx_power_level() API for BT/BLE. Default firmware configuration is for the internal PCB/Chip AntennaB00: Internal antenna (Fractus FR05-S1-N-0-102) and Dipole antenna (Taoglas GW.34.5153)CC0/CC1 1.4 FCC/ETSI: Dipole Antenna (GW.71.5153), dipole Antenna (Inside WLAN PRO-IS 299), PCB antenna (RSIA7), PIFA antenna (Smarteq 4211613980), PIFA antenna (MARS-31A8 Wi-Fi antenna)CC0/CC1 1.3 : PCB antenna , dipole antennaAA0/AA1-1.3: chip antenna, Heavy-duty screw mount antenna
TELEC certification support
Support for chip manufacturing software (Crystal Calibration support for RS9116 QMS chip integration)
Support for examples on the EFR Platform
Package and documentation restructure
Changes and Fixes#
Fixes for memory leak in SSL, ensuring stability for longer connection
Resolved issue with TCP long data transfer with low power configuration for memory configuration greater than 256k.
Fix for setting device local name for BLE
Fix for rsi_ble_white_list_using_adv_data() failure | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-30 | Fix for rsi_ble_white_list_using_adv_data() failure
Fix for store config/auto-config keep-alive timeout not working.
Fix for HID Keyboard notifications not being seen on the iOS mobile side
Configurability support in Firmware update APIs for the SAFE and FAST upgrade
Mishandling of SDIO interrupts addressed in SAPI driver by calling rsi_hal_intr_pin_status() API. MCU HAL APIs will need to port this API for respective platform. Refer to SAPI porting guide for more information.
Boot up Issue at low temperature (refer to API rsi_calib_write() Bit of 3)
New APIs#
For a complete list of new APIs, see SAPI Changelog
Recommendations and New Options#
Wi-Fi#
It is recommended to enable bit 16 of the 'Extended TCP IP Feature' bit map in opermode command for all Wi-Fi Socket Operations from host to ensure graceful handling during asynchronous closures from peer.
Aggregation (bit 2 of feature_bit_map) is recommended to be enabled in opermode.
TCP retransmission count value is recommended to be 30 or higher, so that the TCP does not disconnect while the rejoin happens.
For low throughput applications, such as a Smart lock, disabling the highest MCS rates, such as MCS7 and MCS6 might help reducing packet retransmissions and ensure robust connection during heavy interference.
To restart the module, the application needs to call rsi_driver_deinit() followed by rsi_driver_init() and rsi_device_init(). For OS cases, additionally call rsi_task_destroy(driver_task_handle) to delete the driver task before calling rsi_driver_deinit() and create again after rsi_device_init() using rsi_task_create() | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-31 | Register 'Join Fail Callback' function every time when join is called, as in the rejoin failure path the callback is deregistered. If not done, this might result in a scan not functioning on rejoin failure.
BT/BLE#
In BLE, recommended range of Connection Interval inPower Save (BLE Only) - 100 ms to 1.28 s.BT Classic + BLE Dual Mode is >= 200 ms.Wi-Fi + BLE coex - 30 ms to 250 ms
In BLE, during Connection, the configuration of Scan Interval and Scan Window with same value is not recommended.
In BT Classic, recommended Sniff Interval configuration during Power Save is limited to 100 ms (<= 100).
In BLE, if a device is acting as Central, the scan window (in set_scan_params and create_connection command) must be less than the existing Connection Interval.
In BLE mode, if scanning and advertising is in progress and subsequently gets connected and moves to the central role, scanning and advertising stops. To further establish connection to another peripheral device or to a central device, the application should give a command for starting advertising and scanning again.
Device Power save need to be disabled before BT init and de-init.
Co-Existence#
For Wi-Fi + BLE, during Wi-Fi connection, lesser BLE scan window and larger BLE scan interval are recommended (1:3 or 1:4).
Wi-Fi + BLE AdvertisingAll the advertising intervals are supported, as per the BT Spec. If the Wi-Fi transactions are more, you may observe a slight difference in on-air advertisements compared to the configured intervals.BLE Advertising will be stopped for intervals that collide with Wi-Fi activity. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-32 | Wi-Fi + BLE scanningAll scan intervals are supported as per BT Spec. For better scan results, use scan-window and scan interval in 1:3 or 1:4 ratio when the Wi-Fi scan activity is present.BLE scanning will be stopped for intervals that collide with Wi-Fi activity.
Wi-Fi + BLE Central/Peripheral ConnectionsAll connection intervals are supported as per BT Spec.For stable connection, use optimal connection intervals and max supervision timeout in the presence of Wi-Fi activity.
Wi-Fi + BLE Central/Peripheral Data TransferTo get better throughputs in both Wi-Fi and BLE, use medium connection intervals, such as 45 to 80 ms with Maximum supervision timeout.Ensure Wi-Fi activity consumes lesser intervals.
For Wi-Fi + BT + BLE, Wi-Fi + BT, Wi-Fi + BLE operating modes, connect Wi-Fi ahead of BT/BLE connections to ensure seamless, stable connection for all 3 protocols.
For Wi-Fi + BT + BLE, Wi-Fi + BT, Wi-Fi + BLE operating modes, if BT/BLE needs to be connected ahead of Wi-Fi connection, use with high supervision timeout and high connection interval for BLE and high sniff interval for BT, to ensure seamless, stable connection. This configuration will also ensure a stable BT/BLE connection when Wi-Fi connects/disconnects/rejoins.
Wi-Fi + BLE Central/Peripheral data transfer
System#
For User Store configuration and Configuration Save, do not enable power save or save it as a configuration. If power save is enabled and saved as a configuration, upon boot up, the module will come up with the saved configuration and will go to power save without any indication to the host.
Set Optimization level to O0 in project settings for IDE (KEIL). | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-33 | Set Optimization level to O0 in project settings for IDE (KEIL).
Memory Configuration must be 384K for BT/BLE and Co-Ex Operating ModesUsage of Low Power Flash mode bit (Bit 19 in Extended customer feature bitmap). Enable this bit for Ultra low power standby associated scenarios. This results in about 20µA lower Wi-Fi standby associated current consumption.
Memory Configuration in SAPI functions: The default memory configuration is 384K. Users can configure it to 256/320/384kB by changing the macros defined in the below two filesIn rsi_wlan_config.h : RSI_EXT_CUSTOM_FEATURE_BIT_MAP EXT_FEAT_256K_MODE or EXT_FEAT_320K_MODE or EXT_FEAT_384K_MODEIn rsi_common.c : rsi_uint32_to_4bytes(rsi_opermode->ext_custom_feature_bit_map, (EXT_FEAT_256K_MODE (or) EXT_FEAT_320K_MODE (or) EXT_FEAT_384K_MODE | RSI_EXT_CUSTOM_FEATURE_BIT_MAP));
Apply Opermode commands in AT mode correctly. The wrong opermode in some cases might lead to unspecified behavior.
Set the recommended Power Save Profile (PSP) type to Enhanced Max PSP for Wi-Fi alone mode and MAX PSP for Wi-Fi Co-Ex Modes.
Disable power save during firmware upgrade and re-enable on upgrade completion.
Disable power save for high throughput applications.
The application needs to ensure that it sets RTC with correct timestamp when the feature is enabled before establishing the SSL connection.
Timeout value should be minimum 1 second for socket select and socket receive calls. Timeout value less than 1 second is not currently supported.
For more details, see 'Configuration parameters' in the SAPI Reference Manual.
Known Issues#
Network Stack# | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-34 | Known Issues#
Network Stack#
MQTT disconnects during firmware upgrade using OTAF, when power save is enabled. Disable power save during firmware upgrade and re-enable on upgrade completion.
Newly Added GCM Based Strong Cipher Suites will have performance issues as Hardware support is not available in the current platform.
Recommended MQTT Publish payload is 1 kBytes.
If HTTP Server is configured in the module, MQTT client port should not be port configured on port 80.
Randomize the client port if using rapid connect/disconnect of the MQTT session on the same client port with the power save.
Secure SSL Renegotiation not supported in Embedded Networking Stack.
IPv6 support is not available in this release.
Wi-Fi#
If the station performs the scan in concurrent mode (Wi-Fi STA+AP), it is possible for stations connected to the AP to get disconnected. Enable AP after STA connection is completed.
Issue observed with WPA2 Enterprise Connectivity using Microsoft RADIUS Server.
If BG Scan is enabled along with custom feature bit map bit (8) configuration of the DFS Channel support, issues may occur in getting IP address for the Wi-Fi STA.
BT/BLE#
Wake on Wireless not supported for BLE.
BT-HID might not inter-operate with Apple devices.
In Wi-Fi + BT/BLE Co-Ex mode, high Wi-Fi broadcast traffic might cause BT/BLE disconnections.
Continuous data transfer on SPP (Rx/Tx) with packet size ~800 bytes in some scenarios might lead to BT disconnection. Introduce delay in between transfers to work around this issue.
In Wi-Fi + BT mode when there is continuous Wi-Fi data, you might observe BT not re-connecting to remote after disconnection.
BT-A2DP interoperability issue might be observed with some headsets. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-35 | BT-A2DP interoperability issue might be observed with some headsets.
For BLE, dual role scenario issues might occur when connecting as central if the advertising is also going out for the peripheral role. Central connections can be made after the peripheral connections are established and advertising is stopped.
Co-Existence#
In Co-Ex Mode if power save is enabled, it stays in enabled state even after Wi-Fi disconnection. Disable power save after every radio_init() and enable it when intended by application.
BLE may disconnect with Wi-Fi + BLE configuration and Wi-Fi continuous data transfer when the low BLE supervision timeout is configured. When the supervision timeout is configured with the value of 16 seconds, no disconnections are observed.
WiFi + BLE mode WPS is not working.
Wi-Fi +BLE/BLE only mode: For SPI as host interface, continuous BLE TX Notification might cause the host interface to hang needing a hardware reset. The issue is not seen with discrete burst BLE data.
In Wi-Fi + BT/BLE configuration with Wi-Fi disconnects, BT/BLE reconnection issue is observed (see the earlier section 'Recommended Configurations and Application Development options' in this document).
Interoperability#
QoS Null frames indicating going to Power Save if not acknowledged by AP may cause AP not to sync with the power save state, resulting in Possible disconnections.
If 3rd Party Access Points are periodically not sending beacons, in some scenarios unicast probe requests are not sent from the module, as expected, which might result in disconnections.
System#
A known issue exists with FAST-PSP mode. Use Enhanced MAX-PSP power save.
Wake on Wireless support is tested only for UART AT command interface. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-36 | Wake on Wireless support is tested only for UART AT command interface.
802.11b transmit power of some AA0 modules might be 4 dBm less than that mentioned in data sheets. As a result, connectivity issues might be observed at 2.4 GHz when the AP is far.
Power Save without RAM retention is not working for the SPI interface.
Limitations and Unsupported Features#
Wi-Fi/Network Stack#
AMSDU TX is not supported.
Fragmentation is not supported.
AMSDU's within AMPDU is not supported.
Currently, the module does not support Radio Measurement Requests feature of CCX V2
802.11k is not supported
Short GI is not supported
802.11w is not supported
40 MHz bandwidth in 2.4 GHz band is not supported.
802.11J channels less than 16 are not supported.
USB host interface and USB Power save are not supported.
Total MQTT Command Length, apart from MQTT Publish, should not exceed 150 bytes. This includes at+rsi (start of command) to (end of command)\r\n.
Configure MQTT_VERSION in rsi_mqtt_client.h based on the server configuration; only version 3 and 4 are supported.
3xSSL connections or 1xTCP and 2xSSL connection, connections are supported concurrently in Wi-Fi only mode.
SSL Curve IDs supported are 15-28. SSL handshake with 3rd party clients depends on the SSL Curve ID.
BT/BLE#
BT Sniff mode does not work if BT multiple slaves feature is enabled.
For BLE, if the connection is established with a small connection interval (< 15 ms), simultaneous roles (i.e., Central/Peripheral + Advertising/Scanning) are not supported. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-37 | BLE maximum 2 concurrent connections are supported, which can be either a connection to two peripheral devices or to 1 central and 1 peripheral device.
For BT Classic, only 1 connection is supported at any time
BLE Slave latency value is valid up to 32 only.
BT-A2DP Encoder is not supported in the firmware
BT-A2DP not supported in AT mode
User Gain Table API is not available for BT/BLE Path. Limit the BT/BLE TX power for a specific antenna using rsi_bt_set_antenna_tx_power_level API.
Co-Existence#
In Wi-Fi + BLE during Wi-Fi connection, if both BLE scan interval and window are the same, an issue will occur in successfully making the Wi-Fi connection.
For AT commands, Wi-Fi + BT + BLE (Opermode 9), BT + BLE(Opermode 8) are not working. However, BT, Wi-Fi + BT modes (Opermode 5) works fine. Also, all combinations work fine with SAPI.
Wi-Fi STA + BT + BLE multiprotocol cases require detailed understanding of use cases and associated configurations. Contact Silicon Labs Support for more details.
Wi-Fi AP + BLE, Wi-Fi AP + BT & Wi-Fi AP + BT + BLE modes are not supported.
SDK Refactor#
The SDK folder structure and names were significantly changed in the 2.4 release. For detailed information, see SAPI Changelog
Terminology#
Term
Description
New Features
These items are new to this release
Changes/Issues Fixed
Changes made to existing features found in previous releases of the software.
Enhancements to existing product flow and feature set.
Bug fixes done in the Release
Deprecated Items
Features or functions or APIs that are removed from the distributed release to align with the software roadmap
Known Issues | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
7488a6e0a156-38 | Known Issues
Features or functions that do not work as planned at time of release. Workarounds may be offered to meet short term development goals, but longer-term solutions will be added in future software releases
Limitations/Recommendations
Describes the limitations on product usage and recommendations for optimal use cases | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-release-notes\index.html |
fe05c87d5d92-0 | You are viewing documentation for version: 2.6 (latest) | Version History
SAPI Overview#
The RS9116W Simple API (SAPI) is a comprehensive collection of Wireless, Network Applications, BSD Socket APIs, and RS9116 driver code along with different HALs for mapping to platform interface on which the library may be ported.
This documentation in this section describes the RS9116 WiSeConnect SAPI (Simple API) library, including:
Brief descriptions about the RS9116 WiSeConnect SAPI Architecture
Details about the APIs and configurations available in the SAPI library
Recent updates of the SAPI library changes
SAPI is intended to run on a host MCU with/without RTOS. Use the given APIs without any modifications to make upgrading to future releases easier. Make sure you also update SAPI with the RS9116 device firmware.
RS9116 device includes Wi-Fi, TCP/IP Networking stack with SSL/TLS support up to TLS 1.2, HTTP/HTTPS, Web sockets, DHCP, MQTT client, and Bluetooth 5 stacks embedded. This device requires a separate application processor, which acts as a host. Host can communicate with RS9116 device using one of the interfaces listed below.
RS9116 supports the following interfaces for host interaction:
SPI
UART
SDIO
USB-CDC
SAPI enables easy migration into any platform with its uniform APIs. This library simplifies application development on the host. Users can develop application software without learning the underlying peripheral register interface and other details. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-sapi-reference\index.html |
fe05c87d5d92-1 | RS9116W release consists of two main components, Firmware and SAPI Library. Both components have the same revision number as they are tightly coupled. Latest releases might have bug fixes, enhancements, and new features in SAPI and/or Firmware. Most of the new features have associated APIs, which are available in the latest SAPI release only. It is recommended to always update SAPI and Firmware to same release version.
Features#
Platform-independent, interrupt-driven drivers written in C.
Drivers provide a simpler, functional interface and eliminate the need to manage the low-level host interface protocol.
Common APIs for four host interfaces (SPI, UART, SDIO, USB-CDC), which enables easy migration to different host interfaces.
Supports bare metal and FreeRTOS OS by default. Other RTOS can be supported through OS Abstraction changes.
May be used with Simplicity Studio, Keil uVision and IAR IDEs. The SAPI driver can also be ported for use with other IDEs that use GCC or ARM compiler toolchains. | rtdocs\docs.silabs.com\rs9116-wiseconnect\latest\wifibt-wc-sapi-reference\index.html |
a5c806465ad8-0 | You are viewing documentation for version: 5.0 (latest) | Version History
Silicon Labs Real-Time Locationing (RTL) Library
Release Notes | Downloads
Introduction
Bluetooth 5.1 introduces support for Direction Finding by adding the option to send and receive Constant Tone Extensions (CTEs) after Bluetooth packets. This makes it possible to do phase measurements on antenna arrays and ultimately to determine the direction of an incoming signal. To learn more about the theory of Direction Finding and how to determine the direction of incoming signals, see UG103.18: Bluetooth® Direction Finding Fundamentals.
Beginning with Bluetooth SDK v3.0, Silicon Labs’ Bluetooth stack supports CTE transmitting and receiving features and can take phase measurements on the incoming signal as specified by the Bluetooth standard. Note, however, that the determination of the angle of incidence from the phase measurements is outside of the scope of the standard and must be implemented in the application. To reduce the Time to Market for its customers, Silicon Labs also offers a reference implementation of a Bluetooth-based Real Time Locating System (RTLS), which provides both an out-of-box experience to evaluate the solution and a flexible framework that makes it possible for everyone to create their own RTLS. To get started with the reference implementation, refer to AN1296: Application Development with Silicon Labs’ RTL Library.
Users can also employ custom direction-finding algorithms on top of the Bluetooth stack. This requires deep knowledge in Direction Finding but enables even more flexibility. If you choose this approach, see AN1297: Custom Direction-Finding Solutions using Silicon Labs’ Bluetooth Stack.
The Silicon Labs Direction Finding solution is part of the Bluetooth SDK. If you are not yet familiar with the Silicon Labs Bluetooth SDK, start with QSG169: Bluetooth® SDK v3.x Quick-Start Guide. | rtdocs\docs.silabs.com\rtl-lib\latest\index.html |
a5c806465ad8-1 | Finally, whether you use Silicon Labs’ Direction Finding board or your own design, AN1195: Antenna Array Design Guidelines for Direction Finding provides useful information regarding antenna design. It also provides accuracy measurement results of the RTL library used with Silicon Labs’ Direction Finding board.
For more information and to get started with Bluetooth Direction Finding, see QSG175: Silicon Labs Direction Finding Solution Quick-Start Guide.
Real Time Locating (RTL) Library
Estimating the Angle of Arrival (AoA) or Angle of Departure (AoD) from IQ samples is not trivial, especially in a real environment full of reflections. To optimize development and to speed up time-to-market, Silicon Labs provides a Real Time Locating library (RTL lib), which processes the IQ samples received from the Bluetooth stack, implements multipath detection and azimuth and elevation calculation, and exposes the data to the application via an open API.
Silicon Labs RTL Library Providing Azimuth and Elevation
Furthermore, the library can also estimate the location of a tracked asset in a multi-locator scenario using triangulation, where multiple locators receive CTEs from the same asset tag, provided that the library knows the position of each locator. In this case, the positions of the locators and the estimated angles (AoA) serve as the input, and the estimated location is the output.
Silicon Labs RTL Library Providing X, Y and Z
After the positions are estimated, user’s application has to determine how to process data.
The RTL library provides the following features:
Direction Finding Method
AoA
# of tags supported
infinite (lib needs to be initialized for each, and physical channel puts a limitation on this)
# of locators supported
100
Antenna arrays supported
4x4 URA, 3x3 URA, 1x4 ULA antenna arrays on Silicon Labs Antenna Array board
Modes of operation | rtdocs\docs.silabs.com\rtl-lib\latest\index.html |
a5c806465ad8-2 | Modes of operation
Single shot / Real time,Fast response / Basic / High accuracyAzimuth & elevation / Azimuth only
Supported platforms
Windows x64, Ubuntu x64, Raspbian (Cortex A), Darwin x64
The RTL library is provided as a single static library for each supported platform. The library can be found in the Gecko SDK suite under:
C:\SiliconLabs\SimplicityStudio\v5\developer\sdks\gecko_sdk_suite\v3.3\util\silicon_labs\aox
The library has three API classes, as follows:
Angle of Arrival / Departure (sl_rtl_aox): API used for AoA/AoD estimation from IQ samples. (Currently only AoA is supported.)
Location Finding (sl_rtl_loc): API used for location estimation (x, y, z coordinates) from AoA/AoD.
Utility Functionality (sl_rtl_util_): API grouping utility functions that may be useful during AoA/AoD/location estimation
An IQ Sample Quality Analysis API is also available inside the Angle of Arrival / Departure and Utility Functionality classes to provide analytical measurements of different errors in the system.
Angle of Arrival / Departure
Bluetooth has two direction-finding methods: Angle of Arrival (AoA) estimation and Angle of Departure (AoD) estimation. Currently, the RTL library supports AoA mode only. In this mode, the transmitter transmits a constant tone on a single antenna, and the receiver receives this signal on multiple antennas. Based on their spatial situation, the receiver antennas will receive the same signal with different phase offsets, from which the direction of the incoming signal can be estimated.
Angle of Arrival | rtdocs\docs.silabs.com\rtl-lib\latest\index.html |
a5c806465ad8-3 | Angle of Arrival
While it is easy to estimate the Angle of Arrival in an environment free of noise and reflections, it can get quite challenging in a noisy real-world environment with a lot of reflections. To mitigate the effects of reflections, the RTL library uses different methods, such as spatial and temporal filtering, averaging over multiple frequencies, and so on.
Location Finding
If there are multiple fixed-position locators that can calculate the direction of the transmitter (asset tag), the position of the asset tag can be calculated from the angles using triangulation. In addition to the Angle of Arrival estimation, the RTL library also provides location finding functionality. After the library learns the position of each locator and gathers the angles from each locator, it can provide a position estimation for asset tags. Just as for AoA estimation, challenges introduced by the reflective and noisy environment are addressed.
Location Finding
IQ Sample Quality Analysis
Errors from multiple sources can affect the quality of the received IQ samples. In a real-life environment, some phenomena are considered as normal and not errors, but can also corrupt the perceived IQ data. The most notable example of this is the multipath propagation, which twists the perceived magnitude and phase of the IQ sample data. Its extent depends on the particular antenna location in the array as well as the position and the angle of the followed tag related to the locator antenna array.
The possible sources for the perceived noise may include the following:
Radio receiver analog noise
Quantization noise from the sampling
Leaking signals from the surrounding channels folding into the band of interest
Sampling jitter that translates into noise
Other radio protocols operating on the same band
Cosmic background noise
And so on …. | rtdocs\docs.silabs.com\rtl-lib\latest\index.html |
a5c806465ad8-4 | Other radio protocols operating on the same band
Cosmic background noise
And so on ….
In other words, there are a plenty of sources for signal noise even in relatively good conditions. In addition to the calculation of Angle of Arrival and position estimations, the RTL library also provides functionality called IQ sample quality analysis to help developers find the root cause of angle estimation issues by analyzing statistical properties of the IQ samples.
Real Time Locating System (RTLS) Reference Implementation
Although it is up to developers to determine how the RTL library is used in the application, Silicon Labs offers a reference implementation of a Bluetooth-based Real Time Locating System (RTLS), which provides both an out-of-box experience to evaluate the solution and a flexible framework that makes it possible for everyone to create their own RTLS. The general architecture of this reference RTLS, using Silicon Labs RTL library, looks like this:
General RTLS Architecture as Implemented in the Bluetooth SDK
All AoA related sample apps in the Bluetooth SDK are created so that they support this model. To learn more about the sample apps, see AN1296: Application Development with Silicon Labs’ RTL Library.
Note that on the Locator side the devices work in a Network Co-Processor (NCP) mode, that is, the stack runs on the EFR32 chip, but the application runs on a host computer. Currently, due to the limited computational capacity of the EFR32 chips, only NCP mode is supported, that is the RTL library cannot be used on the chip. To learn more about NCP mode, see AN1259: Using the v3.x Silicon Labs Bluetooth® Stack in Network Co-Processor Mode. | rtdocs\docs.silabs.com\rtl-lib\latest\index.html |
a5c806465ad8-5 | The locators can connect to the central PC in many ways. Silicon Labs’ reference implementation uses MQTT to collect angle data from locators, since it gives the flexibility to run the host sample apps on a distributed network as well as on a single PC using localhost, but other implementations can also be used. | rtdocs\docs.silabs.com\rtl-lib\latest\index.html |
14641d8262af-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
About the Launcher#
This section provides a reference to the functionality available in Simplicity Studio® 5 (SSv5) when you first open the application. This first perspective is called the Launcher perspective. A "perspective" is an Eclipse term for an initial arrangement of views and an editor area.
1 - Welcome and Device-Specific Tabs: The Welcome page includes a Get Started section to help with target kit, board, or device selection. The Learn and Support section may be expanded to show some of the reference and support resources available. Once a device is connected and/or selected, device-specific tabs provide access to example projects, documentation, and so on.
2 - Debug Adapters: Silicon Labs kits and supported debug adapters (for example, SEGGER J-Link products). The icon to the left of the debug adapter item indicates if it is connected over USB or Ethernet.
3 - My Products: Shows an editable list of products that you may want to use as target devices to set the Launcher's context. Use this view to select target devices when you don't have a kit available.
4 - A top-level menu provides access to a number of functions, including configuration options and help. A toolbar offers access to tools and functions on the left and shortcuts to different perspectives on the right.
5 - The Launcher perspective also provides additional functions across the bottom of the perspective:
Log in menu. Here you can:Log in or outRegister a software development kit.Change usersClear stored credentials
Garbage collection status and clear function. Click the trash can to run the garbage collector. This releases memory that may not have been released automatically. You should not need to use this function during normal operation. To turn the display off, go to Preferences > General and uncheck Show heap status. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-about-the-launcher\index.html |
14641d8262af-1 | 6 - A perspectives tool bar in the top right shows open perspectives and allows you to open others.
Click Open Perspective to see a list of available perspectives. The perspectives list is similar to that available through the Window > Perspective menu selection.
Right-click an open perspective to see the context menu. While you can customize the perspective through the Customize menu option (see Help > Help Contents > Workbench User Guide for more information), you can also customize a perspective by dragging views and opening and closing views. These changes are persistent and survive closing and reopening a perspective. Click Reset to restore the perspective to its default settings.
Not all functions available through the Launcher perspective are relevant to developing for all target devices. The Developing for ... pages highlight the key pieces for each device category. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-about-the-launcher\index.html |
92912b581d06-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
About the Simplicity IDE#
The Simplicity Studio® 5 (SSv5) Simplicity Integrated Development Environment (IDE) perspective is designed to support code editing, downloading, and debugging for EFR32 devices and modules and EFM32, EFM8, and 8051 devices.
These pages review the Simplicity IDE User Interface, discuss how to import and export projects, and explore the features supporting code editing. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-about-the-simplicity-ide\index.html |
fbd5393183b8-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
Building and Flashing#
These pages describe:
How to compile or build software into a binary image
How to configure additional build steps using the Post-Build Editor to make customized binary images
How to load or flash that application image onto a connected device | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-building-and-flashing\index.html |
fc924cd12fd6-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
Developing for 8‑Bit Devices#
Hardware Configurator (Configurator) for 8-bit devices is part of Simplicity Studio® 5 (SSv5) and greatly simplifies EFM8 and C8051 MCU peripheral initialization by presenting peripherals and peripheral properties in a graphical user interface.
The 8051 SDK contains an extensive and nearly comprehensive set of examples for 8-bit MCU peripherals for each supported device family. These examples show simple use cases for each peripheral, and can be used as building blocks for larger systems incorporating multiple peripherals, or as a starting place for applications requiring each peripheral. Projects based on these examples are customized by changing code as described in About Projects and by updating peripheral configuration using the 8-bit Hardware Configurator.
In Hardware Configurator, most of the initialization firmware can be generated by selecting peripherals and property values from combo boxes or entering register values in text boxes. Some peripherals provide calculators, such as baud rate, timer overflow rate, and SPI clock rate, that can be used to automatically confirm the necessary reload register value to generate the specified clock rate. Hardware Configurator also provides real-time property validation to ensure that a configuration is valid before downloading code to the MCU. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-developing-for-8bit-devices\index.html |
7a64283c8762-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
Getting Started#
To get started with Simplicity Studio® 5 (SSv5):
Install SSv5 and development software
Explore the main features of SSv5
Start a project
You do not need hardware to install SSv5 and the relevant software packages or, for 32-bit devices, to explore the project configuration interface for a particular SDK. However, having your target hardware connected during installation ensures that your SSv5 installation is configured precisely for your environment.
You should also have an account set up in the Silicon Labs Customer Support Portal. Access to some software packages is controlled by your customer profile.
See Prerequisites for more information.
If you have features or functions that are provided as an SDK extension, you need to install it separately after you have installed the main SDK. See Install SDK Extensions for more information. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-getting-started\index.html |
b4d00eafe761-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
Simplicity Studio® 5 User's Guide#
Simplicity Studio is the core development environment designed to support the Silicon Labs IoT portfolio of system-on-chips (SoCs) and modules. It provides access to target device-specific web and SDK resources; software and hardware configuration tools; an integrated development environment (IDE) featuring industry-standard code editors, compilers and debuggers; and advanced, value-add tools for network analysis and code-correlated energy profiling.
Simplicity Studio is designed to simplify developer workflow. It intelligently recognizes all evaluation and development kit parts released by Silicon Labs and, based on the selected development target, presents appropriate software development kits (SDKs) and other development resources.
Simplicity Studio 5 (SSv5) focuses on developer experience, leveraging feedback from customers, employees and competitive reviews. Developers of all experience levels will benefit from an optimized workflow that supports them through the development journey and produces quicker project progression and device configuration.
The Simplicity Studio 5 User's Guide pages are organized into the following groups.
Getting Started describes how to install SSv5 and the relevant development resources, and provides general overviews of using the SSv5 interface and of developing projects in SSv5. If you are new to SSv5, start here.
About the Launcher is a reference guide to the features and functions available when you first open SSv5. This is a general reference, although some items may not be applicable to all devices.
About the Simplicity IDE is a reference guide to the features and functions in the Simplicity integrated development environment. This is a general reference, although some items may not be applicable to all devices.
Developing for 32-Bit Devices provides instructions and reference material for 32-bit device development in the two development environments: Project Configurator and AppBuilder. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-overview\index.html |
b4d00eafe761-1 | Developing for 8-Bit Devices provides instructions and reference material for 8-bit device development using the Hardware Configurator.
Building and Flashing describes how to compile and flash images to various device types.
Companion IDEs: Visual Studio Code discusses how to generate project code in Simplicity Studio 5 to then be used in the VS Code IDE.
Testing and Debugging outlines tools and strategies for testing your applications on Silicon Labs devices.
Using the Tools is a reference guide to the various tools packaged with SSv5. Not all tools are applicable to every development path. Their specific use is described in the individual Developing for pages. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-overview\index.html |
b6a667019f4b-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
Testing and Debugging#
This section provides information on testing and debugging application firmware.
Overview and Resources reviews the tools that are available and additional documentation.
Using the Debugger provides details on Simplicity Studio's built-in debuggers.
Using Wireshark describes how to connect a device to the Wireshark packet analyzer. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-testing-and-debugging\index.html |
113239d4e8a7-0 | You are viewing documentation for version: 5.6.3 (latest) | Version History
Companion IDEs: Visual Studio Code#
With the Simplicity Studio 5 (SSv5) 5.6.0.0 release, Silicon Labs is introducing beta level support for using Visual Studio Code (VS Code) in combination with SSv5. To add this support, a VS Code extension is also being released. It can be either downloaded directly from the VS Code extension marketplace or with this link: https://marketplace.visualstudio.com/publishers/silabs
SSv5 is still required to create the initial project and to make project changes with the Project Configurator, but when you are using the Visual Studio Code-Compatible project generator, all editing, building, and debugging of the project should be done in VS Code. In other words, do not try to build the project in both Simplicity Studio and in VS Code.
Using the VSCode project Generator#
The Project Configurator includes a new “Visual Studio Code Compatible Project (Beta)” project generator. Once the project is created, from the Project Configurator Overview tab click Change Target/SDK/Generators and enable the VS Code generator.
Click Save and the project is generated, including three new files to support development in VS Code. If a popup dialog appears asking what to do with some project configuration files, leave the setting at the default “Keep my file” and click OK. The three VS Code support files are <projectname>.vscode.Makefile, <projectname>.vscode.project.mak and vscode.conf. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-vscode-ide\index.html |
113239d4e8a7-1 | Make any other project configurator changes to the project and then the project can be continued in VS Code. Once you begin using VS Code for development, it is not recommended to build the project in SSv5. However, before any changes have been made in VS Code, you can verify that it builds in SSv5 before continuing development in VS Code.
The VS Code generator is Gecko SDK Suite (GSDK)-independent. This means it can be used with any 4.x.x GSDK. It has been functionally tested with at least, GSDK 4.0.2, GSDK 4.1.3 and GSDK 4.2.0.
Using the Project in VS Code#
Preparing VS Code for Silicon Labs Support#
To use VS Code for development with Silicon Labs projects, VS Code must first be downloaded and installed from the Visual Studio website (Download Visual Studio Code). Then the Silicon Labs extension must be installed either from within VS Code by clicking on the Extensions icon and then searching the Marketplace for “Simplicity Studio for VS Code” or by downloading the extension as a .vsix file from https://marketplace.visualstudio.com/publishers/silabs and then adding it to VS Code by clicking the three dots next to EXTENSIONS and selecting Install from vsix….
Installing the Simplicity Studio for VS Code extension will also install other extensions it depends on: C++ Extension Pack and Cortex-Debug. VS Code is now ready to add the Silicon Labs project from the earlier step.
Adding a VS Code-Enabled SSv5 Project to VS Code#
You can add a project to VS Code in two ways.
Use File > Open Folder… and browse to the project folder in the Simplicity Studio workspace (default workspace is v5_workspace) or the source-controlled project folder. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-vscode-ide\index.html |
113239d4e8a7-2 | Use File > Add Folder to Workspace… and again browse to the project folder. This second method is recommended, especially if working with multiple projects. This will place the folder in an untitled workspace. Select File > Save Workspace As… and select a folder and name for the workspace. The VS Code workspace should be saved outside of the Simplicity Studio workspace folder in a folder dedicated to VS Code workspaces. Subsequent projects can be added to this open workspace using File > Add Folder to Workspace….
After adding two projects to a workspace VS Code looks like this:
The source files can be edited, and additional files added to the projects. When ready to build the project, select the project build configuration ('all' is the default for now) in the SILICON LABS SUPPORT section and the icons for three support options (build – wrench, flash – down arrow, debug – bug icon) are displayed.
Builds will use make along with the two generated make files and the GNU ARM GCC toolchain specified when the project was created in SSv5. All files and folders in the project folder will be compiled (including user-added source files).
Flash will flash the project .hex file to the target board using Simplicity Commander. The Output console window will display the progress of the flash operation.
Debug will start a debug session using the Segger GDB Server and the GNU ARM GDB Client. The normal options to step through the program, set breakpoints, and examine variables and registers are all supported. The debug control icons are highlighted in the red box in the following figure. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-vscode-ide\index.html |
113239d4e8a7-3 | Note: The vscode.conf file is used as the ‘glue’ file between the project configuration of the Simplicity Studio-installed resources and the Silicon Labs VS Code extension. The links in this file are used by the Silicon Labs VS Code extension to find the associated tools necessary for building, flashing, and debugging the project. It is not meant to be manually edited.
Note for Matter developers: After you have generated your project in Simplicity Studio and added it to VS Code Workspace, Silicon Labs has provided four VS Code tasks to facilitate developing Matter projects in VS Code. See the Matter documentation on https://docs.silabs.com for more information. | rtdocs\docs.silabs.com\simplicity-studio-5-users-guide\latest\ss-5-users-guide-vscode-ide\index.html |
1fdb299630d5-0 | You are viewing documentation for version: 1.0 (latest) | Version History
USB Device
USB is one of the most successful communication interfaces in the history of computer systems and is the de facto standard for connecting computer peripherals.
Silicon Labs USB Device stack is a USB device module designed specifically for embedded systems. Built from the ground up with Silicon Labs’ quality, scalability, and reliability, it has gone through a rigorous validation process to comply with the USB 2.0 specification.
This documentation describes how to initialize, start, and use Silicon Labs USB Device stack. It explains the various configuration values and their uses. It also includes an overview of the technology, types of configuration possibilities, implementation procedures, and examples of typical usage for every available class.
To help you understand the USB concepts quickly, the documentation features many examples of USB with basic functions. These examples will provide you with a framework that allows you to build devices quickly. These examples include:
USB-to-serial adapter (Communications Device Class)
Mouse or keyboard (Human Interface Device Class)
Removable storage device (Mass Storage Class)
Custom device (Vendor Class)
The following is the overview of the documentation sections:
Specifications and Features
USB Device Configuration
USB Device Programming Guide
USB Device Classes
CDC ACM ClassHID ClassMSC SCSI ClassVendor Class
USB Device Troubleshooting
Microsoft Windows OS USB Host | rtdocs\docs.silabs.com\usb\1.0\index.html |
7b8bc2f749d8-0 | Wi-Fi Transceivers & Modules
This page contains documentation for WFx200 based Wi-Fi ICs and Modules. For RS9116 documentation, see RS9116 Wi-Fi/Bluetooth Solutions.
RS9116 Family: Wi-Fi/Bluetooth Solutions
See RS9116 Wi-Fi/Bluetooth Solutions.
WF Series: Wi-Fi Transceiver ICs
A cost-effective and scalable Wi-Fi transceiver family that is targeted at high-volume IoT applications and offers
support for both low- and high-end microcontrollers. A scalable software architecture suits both RTOS and Linux environments.
WF200 Wi-Fi Transceiver
Hardware
Data Sheets
Application Notes
Guides & Manuals
WF200 Wi-Fi Expansion Kit
Software
Wi-Fi LMAC Driver for Linux
Wi-Fi FMAC Driver for MCU
WFM Series: Wi-Fi Transceiver Modules
Building upon the WF200, the certified WFM200 SiP further integrates both the antenna and antenna matching along with a temperature compensated crystal for extended operation up to 105 °C.
WFM200S Wi-Fi Transceiver Module
Hardware
Data Sheets
Application Notes
Guides & Manuals
WFM200S Wi-Fi Expansion Kit
Software
Wi-Fi LMAC Driver for Linux
Wi-Fi FMAC Driver for MCU
WGM Series: Wi-Fi Modules with Apps Processor
The WGM160P contains a WF200 transceiver and a Gecko EFM32 microcontroller which combined provide advanced low-power IoT connectivity. The WGM160P can be used with the Wi-Fi FMAC driver for MCU for an open architecture approach.
WGM160P Wi-Fi Module
Hardware
Data Sheets
Application Notes
Guides & Manuals
WGM160P Wi-Fi Module Starter Kit
Software
Wi-Fi FMAC driver WGM160P example
Gecko OS Documentation | rtdocs\docs.silabs.com\wifi\index.html |