-
Notifications
You must be signed in to change notification settings - Fork 15
Update content SSv6 and tools screenshots #31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: doccurator/26q2p2
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -90,25 +90,31 @@ See [Dynamic Multiprotocol Development with Bluetooth and Proprietary Protocols | |
|
|
||
| ### NCP Host Examples | ||
|
|
||
| NCP host examples are located in \<GSDK-install-location>\app\bluetooth\example_host. | ||
| NCP host examples are located in \<SiSDK-install-location>\bluetooth_le_app\example_host. | ||
|
|
||
| - **bt\_host\_empty:** Minimal host-side project structure, used as a starting point for NCP host applications. Use it with the **Bluetooth – NCP** target application flashed to the radio board. | ||
| - **bt\_aoa\_host\_locator:** A locator host sample app that works together with a **Bluetooth AoA – NCP Locator** target app. It receives IQ samples from the target and estimates the Angle of Arrival (AoA). For more information see [Application Development with Silicon Labs’ RTL Library](https://docs.silabs.com/rtl-lib/latest/direction-finding-solution-guide/). | ||
|
|
||
| - **bt\_host\_ota\_dfu:** Demonstrates how to perform an OTA DFU on a Silicon Labs Bluetooth Device. It requires a WSTK with a radio board flashed with NCP firmware to be used as the GATT client that performs the OTA. | ||
| - **bt\_cs\_host:** This is the host application for the Channel Sounding (CS) NCP target application. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove 'This is' and start the sentence with 'The' |
||
|
|
||
| - **bt\_host\_uart\_dfu:** Demonstrates how to perform a UART DFU on a Silicon Labs Bluetooth Device running NCP firmware. | ||
| - **bt\_host\_cpc\_hci\_bridge:** A background application to be run when HCI interface is exposed via CPC. This application retrieves the HCI commands/events from the CPC messages and forwards them toward the Bluetooth host running on the PC. Similarly, it forwards the HCI commands from the host toward the target over CPC. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update as follows: |
||
|
|
||
| - **bt\_host\_voice:** On a WSTK programmed with NCP firmware, it to connects to the **Bluetooth – SoC Voice** example, sets the correct configuration on it, receives audio via Bluetooth, and stores audio data into a file. | ||
| - **bt\_host\_empty:** Minimal host-side project structure, used as a starting point for NCP host applications. Use it with the **Bluetooth – NCP** target application flashed to the radio board. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: A minimal host-side project structure used as a starting point for NCP host applications. Use it with the Bluetooth – NCP target application flashed to the radio board. |
||
|
|
||
| - **bt\_aoa\_host\_locator:** A locator host sample app that works together with a **Bluetooth AoA – NCP Locator** target app. It receives IQ samples from the target and estimates the Angle of Arrival (AoA). For more information see [Application Development with Silicon Labs’ RTL Library](https://docs.silabs.com/rtl-lib/latest/direction-finding-solution-guide/). | ||
| - **bt\_host\_esl\_ap:** This Python example implements the functionality of an Access Point as specified by the Bluetooth Electronic Shelf Label Profile specification using an NCP ESL AP target. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: A Python example that implements Access Point functionality as specified in the Bluetooth Electronic Shelf Label Profile specification. Use it with an NCP ESL AP target. |
||
|
|
||
| - **bt\_host\_positioning:** Connects to multiple **bt\_aoa\_host\_locator** sample apps (via MQTT) and estimates a position from Angles of Arrival (AoA). For more information, see *QS175: Application Development with Silicon Labs’ RTL Library.* | ||
| - **bt\_host\_ncp\_test:** This Network Co-Processor (NCP) host application serves 2 purposes. It demonstrates (1) how to use user NCP commands and (2) how to implement a simple application to test NCP performance using the default user commands. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A Network Co-Processor (NCP) host application that serves two purposes. It demonstrates how to use user NCP commands and how to implement a simple application to test NCP performance using the default user commands. |
||
|
|
||
| - **bt\_host\_positioning\_gui:** Connects to the **bt\_host\_positioning** sample app (via MQTT), reads out the position estimations and displays the tags and locators on a 3D GUI. This sample app is python based. For more information, see [Application Development with Silicon Labs’ RTL Library](https://docs.silabs.com/rtl-lib/latest/direction-finding-solution-guide/). | ||
| - **bt\_host\_ota\_dfu:** Demonstrates how to perform an OTA DFU on a Silicon Labs Bluetooth Device. It requires a WSTK with a radio board flashed with NCP firmware to be used as the GATT client that performs the OTA. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: Demonstrates how to perform an OTA DFU on a Silicon Labs Bluetooth device. It requires a WSTK with a radio board flashed with NCP firmware. The WSTK acts as the GATT client that performs the OTA. |
||
|
|
||
| - **bt\_host\_positioning:** Connects to multiple **bt\_aoa\_host\_locator** sample apps (via MQTT) and estimates a position from Angles of Arrival (AoA). For more information, see *QS175: Application Development with Silicon Labs’ RTL Library.* | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: Connects to multiple bt_aoa_host_locator sample apps through MQTT and estimates a position from Angles of Arrival (AoA). For more information, see QS175: Application Development with Silicon Labs’ RTL Library. |
||
|
|
||
| - **bt\_host\_throughput:** Tests the throughput capabilities of the device in NCP mode and can be used to measure throughput between two devices as well as between a device and a smartphone. | ||
|
|
||
| - **bt\_host\_cpc\_hci\_bridge:** A background application to be run when HCI interface is exposed via CPC. This application retrieves the HCI commands/events from the CPC messages and forwards them toward the Bluetooth host running on the PC. Similarly, it forwards the HCI commands from the host toward the target over CPC. | ||
| - **bt\_host\_uart\_dfu:** Demonstrates how to perform a UART DFU on a Silicon Labs Bluetooth Device running NCP firmware. | ||
|
|
||
| - **bt\_host\_voice:** On a WSTK programmed with NCP firmware, it to connects to the **Bluetooth – SoC Voice** example, sets the correct configuration on it, receives audio via Bluetooth, and stores audio data into a file. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: On a WSTK programmed with NCP firmware, the application connects to the Bluetooth – SoC Voice example, configures it, receives audio over Bluetooth, and stores the audio data in a file. |
||
|
|
||
| - **bt\_host\_positioning\_gui:** Connects to the **bt\_host\_positioning** sample app (via MQTT), reads out the position estimations and displays the tags and locators on a 3D GUI. This sample app is python based. For more information, see [Application Development with Silicon Labs’ RTL Library](https://docs.silabs.com/rtl-lib/latest/direction-finding-solution-guide/). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: Connects to the bt_host_positioning sample app through MQTT, reads the position estimates, and displays the tags and locators in a 3D GUI. This sample app is Python-based. For more information, see ... |
||
|
|
||
| ## Code Examples | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| # Getting Started with Silicon Labs Bluetooth LE Development | ||
|
|
||
| To get started with Bluetooth LE development, download the Simplicity Studio Development environment | ||
| as described in the [Simplicity Studio 5 User's Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-getting-started/). Simplicity Studio 5 includes everything needed for IoT product development with Silicon Labs devices including a resource and project launcher, software configuration tools, full IDE with GNU toolchain, and analysis tools. | ||
| as described in the [Simplicity Studio 6 User's Guide](https://docs.silabs.com/ssv6ug/latest/ssv6ug-overview/). Simplicity Studio 6 includes everything needed for IoT product development with Silicon Labs devices including a resource and project launcher, software configuration tools, full IDE with GNU toolchain, and analysis tools. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase the last sentence: |
||
|
|
||
| Once you have downloaded Simplicity Studio, you will be prompted to install the Gecko SDK (GSDK), which contains the Bluetooth Software Development Kit (SDK). The GSDK combines Silicon Labs wireless SDKs and Gecko Platform into a single, integrated package. The Bluetooth SDK comes with a number of example application that you can then modify to create your own applications. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you are prompted to install |
||
|
|
||
| See [Prerequisites](#prerequisites) for additional details. | ||
|
|
||
| These pages focus on use and development in the Simplicity Studio 5 environment. Alternatively, Gecko SDK may be installed manually by downloading or cloning the latest from GitHub. See the [GitHub site](https://github.com/SiliconLabs/gecko_sdk) for more information. | ||
| These pages focus on use and development in the Simplicity Studio 6 environment. Alternatively, Gecko SDK may be installed manually by downloading or cloning the latest from GitHub. See the [GitHub site](https://github.com/SiliconLabs/gecko_sdk) for more information. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
|
|
||
| Silicon Labs provides two different starter kits. The links below provide specific instructions for getting started with each kit. | ||
|
|
||
|
|
@@ -24,7 +24,7 @@ Before beginning application development, you should have: | |
|
|
||
| - Purchased an EFR32BG Wireless Starter Kit or BGM220 Explorer Kit. | ||
| - Created an account at Silicon Labs. You can register at [https://siliconlabs.force.com/apex/SL_CommunitiesSelfReg?form=short](https://siliconlabs.force.com/apex/SL_CommunitiesSelfReg?form=short). | ||
| - Downloaded Simplicity Studio 5 and the Silicon Labs Gecko SDK containing the Bluetooth SDK and become generally familiar with the SSv5 Launcher perspective. SSv5 installation and getting started instructions along with a set of detailed references can be found in the online *Simplicity Studio 5 User’s Guide*, available on [https://docs.silabs.com/](https://docs.silabs.com/) and through the SSv5 help menu. | ||
| - Downloaded Simplicity Studio 6 and the Silicon Labs Simplicity SDK containing the Bluetooth SDK and become generally familiar with the SSv6 Launcher perspective. SSv6 installation and getting started instructions along with a set of detailed references can be found in the online *Simplicity Studio 6 User’s Guide*, available on [https://docs.silabs.com/](https://docs.silabs.com/) and through the SSv6 help menu. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
| - Obtained a compatible compiler (See the Bluetooth SDK’s release notes for the compatible versions): | ||
|
|
||
| - Simplicity Studio comes with a free GCC C-compiler. | ||
|
|
@@ -49,12 +49,12 @@ The Gecko Platform is a set of drivers and other lower layer features that inter | |
|
|
||
| ## Documentation | ||
|
|
||
| Hardware-specific documentation may be accessed through links on the part Overview tab in Simplicity Studio 5. | ||
| Hardware-specific documentation may be accessed through links on the part Overview tab in Simplicity Studio 6. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Access hardware-specific documentation from the links on the part Overview tab in Simplicity Studio 6. |
||
|
|
||
|  | ||
|
|
||
| ## Support | ||
|
|
||
| You can access the Silicon Labs support portal at [https://www.silabs.com/support](https://www.silabs.com/support) through Simplicity Studio 5’s Welcome view under Learn and Support. Use the support portal to contact Customer Support for any questions you might have during the development process. | ||
| You can access the Silicon Labs support portal at [https://www.silabs.com/support](https://www.silabs.com/support) through Simplicity Studio 6’s Welcome view under Learn and Support. Use the support portal to contact Customer Support for any questions you might have during the development process. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
|
|
||
|  | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,7 +49,7 @@ The following diagram summarizes the procedure involving both the advertiser and | |
|
|
||
| ### Configuration | ||
|
|
||
| The *max_advertisers* in the Bluetooth configuration structure also configures the maximum number of periodic advertisers. You can set the number of advertisers by opening the Bluetooth Core configurator tab from the Software Components: | ||
| The *max_advertisers* in the Bluetooth configuration structure also configures the maximum number of periodic advertisers. You can set the number of advertisers by opening the Connection configurator tab from the Software Components: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase second sentence: |
||
|
|
||
|  | ||
|
|
||
|
|
@@ -97,9 +97,9 @@ The command above can be used to set an advertisement data with a maximum length | |
|
|
||
| ### Configuration | ||
|
|
||
| *max_periodic_sync* in the Bluetooth config configures the maximum number of synchronizations the Bluetooth stack needs to support. The value can be set in the Bluetooth Core configuration, as shown below: | ||
| *max_periodic_sync* in the Bluetooth config configures the maximum number of synchronizations the Bluetooth stack needs to support. The value can be set in the Periodic Advertising Synchronization configuration, as shown below: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
|
|
||
|  | ||
|  | ||
|
|
||
| ### Enabling the Feature | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,8 +30,6 @@ When a connection is opened, an *sl_bt_evt_connection_opened* event is generated | |
|
|
||
| To learn more about handling multiple connections, see[Multi-Peripheral Topology](./multi-peripheral-topology.md) and [Multi-Central Topology](./multi-central-topology.md). | ||
|
|
||
| By default, four simultaneous connections are enabled in the stack. To increase the number of supported connections, go to the configuration of the **Bluetooth Core** software component and increase the *Maximum number of connections*: | ||
|
|
||
|  | ||
| By default, four simultaneous connections are enabled in the stack. To increase the number of supported connections, go to the configuration of the **Connection** software component and increase the *Max number of connections reserved for user*: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
|
|
||
|  | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,9 +26,7 @@ After the advertising is started, a central device can discover the peripheral a | |
|
|
||
| > It is worth keeping count of the live connections and not re-starting advertising after the limit of maximum number of connections is reached. | ||
|
|
||
| By default, four simultaneous connections are enabled in the stack. To increase the number of supported connections, go to the configuration of the **Bluetooth Core** software component and increase the *Maximum number of connections*: | ||
|
|
||
|  | ||
| By default, four simultaneous connections are enabled in the stack. To increase the number of supported connections, go to the configuration of the **Connection** software component and increase the *Max number of connections reserved for user*: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
|
|
||
|  | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,11 +13,9 @@ A new connection (toward an advertising Bluetooth device) can be initiated with | |
|
|
||
| Note that you cannot issue multiple *sl_bt_connection_open* commands immediately after each other even if you know all Bluetooth addresses you want to connect to. You always have to wait for the *sl_bt_evt_connection_opened* event to arrive before initiating a new connection. It is even better if you wait until the *sl_bt_evt_connection_parameters* event because at that moment the connection can be considered stable. To discover the GATT database of the remote device, do so before issuing the second *sl_bt_connection_open* command. | ||
|
|
||
| By default, four simultaneous connections are enabled in the stack. To increase the number of supported connections, go to the configuration of the **Bluetooth Core** software component and increase the *Maximum number of connections*: | ||
| By default, four simultaneous connections are enabled in the stack. To increase the number of supported connections, go to the configuration of the **Connection** software component and increase the *Max number of connections reserved for user*: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rephrase: |
||
|
|
||
|  | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Saving Connection Handles | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -88,23 +88,22 @@ Gecko Bootloader is included in the Gecko SDK Suite. A number of predefined conf | |
| To create a new bootloader project: | ||
|
|
||
| 1. Open Simplicity Studio and select your device in the Devices or Debug Adapters tab. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. on the Devices or Debug Adapters tab. |
||
| 2. Check the Preferred SDK under General Information in the OVERVIEW tab. | ||
| 3. Click EXAMPLE PROJECTS & DEMOS tab, and select Bootloader under Technology Type section. | ||
| 4. Select the appropriate Gecko Bootloader application type for your device **(e.g., Internal Storage Bootloader)**, click FINISH. | ||
| 2. Check the Preferred SDK version. | ||
| 3. Click **EXAMPLE PROJECTS & DEMOS** tab, and select Bootloader under MCU section. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and then select Bootloader in the MCU section. |
||
| 4. Select the appropriate Bootloader application type for your device **(e.g., Internal Storage Bootloader)**, click **CREATE**. | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Select the appropriate bootloader application type for your device, such as Internal Storage Bootloader, and then select CREATE. |
||
|  | ||
|
|
||
| ### Add Security Features | ||
|
|
||
| After the bootloader project is created, the Application Builder automatically opens up. To add security features, do the following: | ||
|
|
||
| 1. Open the **Plugins** tab. | ||
| 2. Click on **Bootloader Core**. | ||
| 3. On the right side tick the checkboxes: | ||
| 1. Open the **Software components** tab. | ||
| 2. Select **Bootloader Core** and click **Configure**. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and then select Configure. |
||
| 3. Enable the following features: | ||
| - Require signed firmware upgrade files. | ||
| - Require encrypted firmware upgrade files. | ||
| - Enable secure boot. | ||
| 4. Click Generate in the upper right corner. | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -161,12 +160,15 @@ Because OTA DFU is not fully implemented in the Bootloader, a minimal Bluetooth | |
| To create a basic application that supports OTA DFU, do the following: | ||
|
|
||
| 1. Open Simplicity Studio and select your device in the Devices or Debug Adapters tab. | ||
| 2. Check the Preferred SDK under General Information in the OVERVIEW tab. | ||
| 2. Check the Preferred SDK version. | ||
| 3. Click EXAMPLE PROJECTS & DEMOS tab, and select Bluetooth under Technology Type section. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Select the EXAMPLE PROJECTS & DEMOS tab, and then select Bluetooth in the Technology Type section. |
||
| 4. Select **Bluetooth - SoC Empty** sample application, and click FINISH. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and then select Finish |
||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### Build the Basic Application | ||
|
|
||
| The application code is automatically generated after the project is created. The **Bluetooth - SoC Empty** sample application contains everything needed for OTA support (OTA service and characteristics + code to support to restart the device in DFU mode + Apploader image. These are all added by the OTA DFU software component). To build the application, do the following: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update as follows: