Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
mtb-example-btstack-threadx-findme/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
277 lines (154 sloc)
23.7 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Bluetooth® LE Find Me | |
| This code example demonstrates the implementation of a simple Bluetooth® Immediate Alert Service (IAS)-based Find Me Profile (FMP) using Infineon AIROC™ Wi-Fi & Bluetooth® combo SoC devices and ModusToolbox™ software environment. | |
| [View this README on GitHub.](https://github.com/Infineon/mtb-example-btstack-threadx-findme) | |
| [Provide feedback on this code example.](https://cypress.co1.qualtrics.com/jfe/form/SV_1NTns53sK2yiljn?Q_EED=eyJVbmlxdWUgRG9jIElkIjoiQ0UyMzg3ODYiLCJTcGVjIE51bWJlciI6IjAwMi0zODc4NiIsIkRvYyBUaXRsZSI6IkJsdWV0b290aCZyZWc7IExFIEZpbmQgTWUiLCJyaWQiOiJ2ZWxtdXJ1Z2FuIiwiRG9jIHZlcnNpb24iOiIxLjAuMCIsIkRvYyBMYW5ndWFnZSI6IkVuZ2xpc2giLCJEb2MgRGl2aXNpb24iOiJNQ0QiLCJEb2MgQlUiOiJJQ1ciLCJEb2MgRmFtaWx5IjoiV0lGSSJ9) | |
| ## Requirements | |
| - [ModusToolbox™ software](https://www.infineon.com/modustoolbox) v3.2 or later (tested with v3.2) with ModusToolbox™. | |
| - Board support package (BSP) minimum required version for : v1.0.0. | |
| - Programming language: C | |
| - Associated parts: CYW955913EVK-01 | |
| ## Supported toolchains (make variable 'TOOLCHAIN') | |
| - GNU Arm® embedded compiler v11.3.1 (`GCC_ARM`) - Default value of `TOOLCHAIN` | |
| ## Supported kits (make variable 'TARGET') | |
| - [CYW955913EVK-01 Wi-Fi Bluetooth® Prototyping Kit](https://www.infineon.com/CYW955913EVK-01) (`CYW955913EVK-01`) | |
| - [CYW955513EVK-01 Wi-Fi Bluetooth® Prototyping Kit](https://www.infineon.com/CYW955513EVK-01) (`CYW955513EVK-01`) | |
| ## Hardware setup | |
| This example uses the kit’s default configuration. See the respective kit guide to ensure that the kit is configured correctly. | |
| **Note:** The CYW955513EVK-01 Wi-Fi Bluetooth® prototyping kit ships with KitProg3 version 2.30 installed. The ModusToolbox™ software requires KitProg3 with latest version 2.50. Before using this code example, make sure that the board is upgraded to KitProg3 2.50. The tool and instructions are available in the [Firmware Loader](https://github.com/Infineon/Firmware-loader) GitHub repository. If you do not upgrade, you will see an error such as "unable to find CMSIS-DAP device" or "KitProg firmware is out of date". | |
| ## Software setup | |
| This code example consists of two parts: a locator and a target. | |
| For the locator, download and install the AIROC™ Bluetooth® Connect app for [iOS](https://apps.apple.com/in/app/airoc-bluetooth-connect-app/id6443702288) or [Android](https://play.google.com/store/apps/details?id=com.infineon.airocbluetoothconnect). | |
| You can also use other Android or iOS apps that support the IAS service. | |
| Scan the following QR codes from your mobile phone to download the AIROC™ Bluetooth® Connect app. | |
|  | |
| ## Using the code example | |
| Create the project and open it using one of the following: | |
| <details><summary><b>In Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Click the **New Application** link in the **Quick Panel** (or, use **File** > **New** > **ModusToolbox™ Application**). This launches the [Project Creator](https://www.infineon.com/ModusToolboxProjectCreator) tool. | |
| 2. Pick a kit supported by the code example from the list shown in the **Project Creator - Choose Board Support Package (BSP)** dialog. | |
| When you select a supported kit, the example is reconfigured automatically to work with the kit. To work with a different supported kit later, use the [Library Manager](https://www.infineon.com/ModusToolboxLibraryManager) to choose the BSP for the supported kit. You can use the Library Manager to select or update the BSP and firmware libraries used in this application. To access the Library Manager, click the link from the **Quick Panel**. | |
| You can also just start the application creation process again and select a different kit. | |
| If you want to use the application for a kit not listed here, you may need to update the source files. If the kit does not have the required resources, the application may not work. | |
| 3. In the **Project Creator - Select Application** dialog, choose the example by enabling the checkbox. | |
| 4. (Optional) Change the suggested **New Application Name**. | |
| 5. The **Application(s) Root Path** defaults to the Eclipse workspace which is usually the desired location for the application. If you want to store the application in a different location, you can change the *Application(s) Root Path* value. Applications that share libraries should be in the same root path. | |
| 6. Click **Create** to complete the application creation process. | |
| For more details, see the [Eclipse IDE for ModusToolbox™ software user guide](https://www.infineon.com/MTBEclipseIDEUserGuide) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mt_ide_user_guide.pdf*). | |
| </details> | |
| <details><summary><b>In command-line interface (CLI)</b></summary> | |
| ModusToolbox™ software provides the Project Creator as both a GUI tool and a command line tool, "project-creator-cli". The CLI tool can be used to create applications from a CLI terminal or from within batch files or shell scripts. This tool is available in the *{ModusToolbox™ software install directory}/tools_{version}/project-creator/* directory. | |
| Use a CLI terminal to invoke the "project-creator-cli" tool. On Windows, use the command line "modus-shell" program provided in the ModusToolbox™ software installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ software tools. You can access it by typing `modus-shell` in the search box in the Windows menu. In Linux and macOS, you can use any terminal application. | |
| The "project-creator-cli" tool has the following arguments: | |
| Argument | Description | Required/optional | |
| ---------|-------------|----------- | |
| `--board-id` | Defined in the `<id>` field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required | |
| `--app-id` | Defined in the `<id>` field of the [CE](https://github.com/Infineon?q=ce-manifest&type=&language=&sort=) manifest | Required | |
| `--target-dir`| Specify the directory in which the application is to be created if you prefer not to use the default current working directory | Optional | |
| `--user-app-name`| Specify the name of the application if you prefer to have a name other than the example's default name | Optional | |
| <br> | |
| The following example will clone the "[Bluetooth® LE Find Me](replace_code_example_github_link)" application with the desired name "LE_Find_Me" configured for the *CYW955913EVK-01* BSP into the specified working directory, *C:/mtb_projects*: | |
| ``` | |
| project-creator-cli --board-id CYW955913EVK-01 --app-id mtb-example-btstack-threadx-findme --user-app-name LE_Find_Me --target-dir "C:/mtb_projects" | |
| ``` | |
| **Note:** The project-creator-cli tool uses the `git clone` and `make getlibs` commands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the [ModusToolbox™ software user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*) | |
| </details> | |
| <details><summary><b>In third-party IDEs</b></summary> | |
| Use one of the following options: | |
| - **Use the standalone [Project Creator](https://www.infineon.com/ModusToolboxProjectCreator) tool:** | |
| 1. Launch Project Creator from the Windows Start menu or from *{ModusToolbox™ software install directory}/tools_{version}/project-creator/project-creator.exe*. | |
| 2. In the initial **Choose Board Support Package** screen, select the BSP and click **Next**. | |
| 3. In the **Select Application** screen, select the appropriate IDE from the **Target IDE** drop-down menu. | |
| 4. Click **Create** and follow the instructions printed in the bottom pane to import or open the exported project in the respective IDE. | |
| <br /> | |
| - **Use command-line interface (CLI):** | |
| 1. Follow the instructions from the **In command-line interface (CLI)** section to create the application. | |
| 2. Export the application to a supported IDE using the `make <ide>` command. | |
| 3. Follow the instructions displayed in the terminal to create or import the application as an IDE project. | |
| For a list of supported IDEs and more details, see the "Exporting to IDEs" section of the [ModusToolbox™ software user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| </details> | |
| ## Operation | |
| 1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector. | |
| 2. Use your favorite serial terminal application and connect to the debug COM port. Configure the terminal application to access the serial port using the following settings: | |
| Baud rate: 115200 bps; Data: 8 bits; Parity: None; stop: 1 bit; Flow control: None; New line for receive data: Line Feed(LF) or auto setting | |
| 3. Program the board using one of the following: | |
| <details><summary><b>Using Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Select the application project in the Project Explorer. | |
| 2. In the **Quick Panel**, scroll down, and click **\<Application Name> Program (LE_Find_me Program(based on app name given by user))**. | |
| </details> | |
| <details><summary><b>Using CLI</b></summary> | |
| From the terminal, execute the `make program` command to build and program the application using the default toolchain to the default target. The default toolchain and target are specified in the application's Makefile but you can override those values manually: | |
| ``` | |
| make program TARGET=<BSP> TOOLCHAIN=<toolchain> | |
| ``` | |
| Example: | |
| ``` | |
| make program TOOLCHAIN=GCC_ARM | |
| ``` | |
| </details> | |
| **Note:** Before building the application, ensure that the *deps* folder contains the BSP file (*TARGET_xxx.lib*) corresponding to the TARGET. Execute the `make getlibs` command to fetch the BSP contents before building the application. | |
| 4. After programming, reset the board. Observe the messages on the UART terminal, and wait for the device to make all the required connections. Use the Debug UART COM port to view the Bluetooth® stack and application trace messages in the terminal window. Sample serial window after performing all the steps are given below: | |
| **Figure 2. Log messages on Debug COM port** | |
|  | |
| 5. To test using the AIROC™ Bluetooth® Connect mobile app, do the following (see equivalent AIROC™ Bluetooth® Connect app screenshots in Figure 3 and Figure 4: | |
| 1. Turn ON Bluetooth® on your Android or iOS device. | |
| 2. Launch the AIROC™ Bluetooth® Connect app. | |
| 3. If it is present on the kit, CYBSP_USER_LED2 will start blinking to indicate that advertising has started. Advertising will stop after 120 seconds if a connection has not been established, and CYBSP_USER_LED2 will turn off. | |
| 4. Swipe down on the AIROC™ Bluetooth® Connect app home screen to start scanning for Bluetooth® LE peripherals; your device (“Find Me Target”) appears in the AIROC™ Bluetooth® Connect app home screen. Select your device to establish a Bluetooth® LE connection. Once the connection is established, CYBSP_USER_LED2 changes from blinking state to always ON state. | |
| 5. Select the 'Find Me Profile' from the carousel view. | |
| 6. Select an *Alert Level* value on the Find Me Profile screen. Observe the state of CYBSP_USER_LED1 on the device; it changes based on the alert level. | |
| 7. For No alert, CYBSP_USER_LED1 shall be OFF. For Mild alert, CYBSP_USER_LED1 shall be blinking. For High alert, CYBSP_USER_LED1 shall be in ON condition. | |
| **Figure 3. Testing with the AIROC™ Bluetooth® Connect app on iOS** | |
|  | |
| <br> | |
| **Figure 4. Testing with the AIROC™ Bluetooth® Connect app on Android** | |
|  | |
| ## Debugging | |
| You can debug the example to step through the code. In the IDE, use the **\<Application Name> Debug (KitProg3_MiniProg4)** configuration in the **Quick Panel**. For more details, see the "Program and debug" section in the [Eclipse IDE for ModusToolbox™ software user guide](https://www.infineon.com/dgdl/Infineon-Eclipse_IDE_for_ModusToolbox_User_Guide_1-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99bcb86331e8). | |
| **Note:** Debugging is not supported for now and will be part of next release. | |
| **Note:** Debugging is of limited value when there is an active Bluetooth® LE connection because as soon as the Bluetooth® LE device stops responding, the connection will get dropped. | |
| ## Design and implementation | |
| Figure 5 shows the implementation of IAS with 'Find Me Locator' (The Bluetooth® LE Central device) as a Bluetooth® LE GATT Client and 'Find Me Target' (Peripheral device) as a Bluetooth® LE GATT Server. | |
| **Figure 5. Find Me Profile (FMP) implementation on CYW955913** | |
|  | |
| The Bluetooth® LE Find Me Profile defines what happens when the locating Central device broadcasts a change in the alert level. | |
| The Find Me Locator performs service discovery using the "GATT Discover All Primary Services" procedure. The Bluetooth® LE service characteristic discovery is done by the "Discover All Characteristics of a Service" procedure. When the Find Me Locator wants to cause an alert on the Find Me Target, it writes an alert level in the Alert Level characteristic of the IAS. When the Find Me Target receives an alert level, it indicates the level using the red LED: OFF for no alert, blinking for mild alert, and ON for high alert. | |
| The application code and Bluetooth® stack runs on the Arm® Cortex®-M33 core of the CYW955913 SoC. The important source files relevant for the user application level code for this code example are listed in related resources section. | |
| **Figure 6. Find Me Profile (FMP) process flowchart** | |
|  | |
| ## Resources and settings | |
| This section explains the ModusToolbox™ software resources and their configuration as used in this code example. Note that all the configuration explained in this section has already been done in the code example. | |
| - **Device Configurator:** ModusToolbox™ software stores the configuration settings of the application in the *design.modus* file. This file is used by the Device Configurator, which generates the configuration firmware. This firmware is stored in the application’s *GeneratedSource* folder. | |
| By default, all applications in a workspace share the same *design.modus* file – i.e., they share the same pin configuration. Each BSP has a default *design.modus* file in the *mtb_shared\TARGET_\<bsp name\>\\<version\>\COMPONENT_BSP_DESIGN_MODUS* directory. It is not recommended to modify the configuration of a standard BSP directly. | |
| To modify the configuration for a single application or to create a custom BSP, see the [ModusToolbox™ user guide](https://www.infineon.com/dgdlac/Infineon-ModusToolbox_User_Guide-Software-v01_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0f8c66a4767a). This example uses the default configuration. See the [Device Configurator guide](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Device_Configurator_Guide_4-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99ab297631cb). | |
| - **Bluetooth® Configurator:** The Bluetooth® peripheral has an additional configurator called the “Bluetooth® Configurator” that is used to generate the Bluetooth® LE GATT database and various Bluetooth® settings for the application. These settings are stored in the file named *design.cybt*. | |
| Note that unlike the Device Configurator, the Bluetooth® Configurator settings and files are local to each respective application. As explained in the [Design and implementation](#design-and-implementation) section, the only extra service added is the Immediate Alert Service (IAS). See the [Bluetooth® Configurator guide](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Bluetooth_Configurator_Guide_3-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99aaf5b231be). | |
| **Table 1. Application resources** | |
| | Resource | Alias/object | Purpose | | |
| | :------- | :------------ | :------------ | | |
| | UART (HAL)|cy_retarget_io_uart_obj| UART HAL object used by Retarget-IO for Debug UART port| | |
| | GPIO (HAL) | CYBSP_USER_LED1 | Changes the state depending on the alert level| | |
| | GPIO (HAL) | CYBSP_USER_LED2 | Depicts device states| | |
| | PWM (HAL) | adv_led_pwm | PWM HAL object for controlling the advertising LED (CYBSP_USER_LED2)| | |
| | PWM (HAL) | ias_led_pwm | PWM HAL object for controlling the alert level LED (CYBSP_USER_LED1)| | |
| <br> | |
| ## Related resources | |
| Resources | Links | |
| -----------| ---------------------------------- | |
| Application notes | | | |
| Code examples | [Using ModusToolbox™ software](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) on GitHub | |
| Device documentation | [btsdk-drivers](https://github.com/Infineon/btsdk-drivers) – Bluetooth® SDK drivers library <br> [btsdk-mesh](https://github.com/Infineon/btsdk-mesh) – Bluetooth® LE mesh libraries <br> [btsdk-ota](https://github.com/Infineon/btsdk-ota) – Bluetooth® LE OTA libraries <br> [btsdk-ble](https://github.com/Infineon/btsdk-ble) – Bluetooth® LE profile libraries | |
| Tools | [Eclipse IDE for ModusToolbox™ software](https://www.infineon.com/cms/en/design-support/tools/sdk/modustoolbox-software/) – ModusToolbox™ software is a collection of easy-to-use software and tools enabling rapid development with Infineon® MCUs, covering applications from embedded sense and control to wireless and cloud-connected systems using AIROC™ Wi-Fi and Bluetooth® connectivity devices. <br> [btsdk-utils](https://github.com/Infineon/btsdk-utils) – Bluetooth® SDK utilities <br> [btsdk-peer-apps-ota](https://github.com/Infineon/btsdk-peer-apps-ota) – Bluetooth® LE OTA peer applications <br> [btsdk-host-peer-apps](https://github.com/Infineon/btsdk-host-peer-apps-mesh) – Bluetooth® LE mesh host and peer applications <br> [btsdk-host-apps-bt-ble](https://github.com/Infineon/btsdk-host-apps-bt-ble) – Bluetooth® and Bluetooth® LE host applications | |
| <br> | |
| ## Other resources | |
| Infineon provides a wealth of data at www.infineon.com to help you select the right device, and quickly and effectively integrate it into your design. | |
| ## Document history | |
| Document title: *CE238786* – *Bluetooth® LE Find Me* | |
| | Version | Description of change | | |
| | ------- | --------------------- | | |
| | 1.0.0 | New code example | | |
| ------------------------------------------------------------------------------- | |
| © Cypress Semiconductor Corporation, 2019-2023. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, and its affiliates ("Cypress"). This document, including any software or firmware included or referenced in this document ("Software"), is owned by Cypress under the intellectual property laws and treaties of the United States and other countries worldwide. Cypress reserves all rights under such laws and treaties and does not, except as specifically stated in this paragraph, grant any license under its patents, copyrights, trademarks, or other intellectual property rights. If the Software is not accompanied by a license agreement and you do not otherwise have a written agreement with Cypress governing the use of the Software, then Cypress hereby grants you a personal, non-exclusive, nontransferable license (without the right to sublicense) (1) under its copyright rights in the Software (a) for Software provided in source code form, to modify and reproduce the Software solely for use with Cypress hardware products, only internally within your organization, and (b) to distribute the Software in binary code form externally to end users (either directly or indirectly through resellers and distributors), solely for use on Cypress hardware product units, and (2) under those claims of Cypress’s patents that are infringed by the Software (as provided by Cypress, unmodified) to make, use, distribute, and import the Software solely for use with Cypress hardware products. Any other use, reproduction, modification, translation, or compilation of the Software is prohibited. | |
| <br> | |
| TO THE EXTENT PERMITTED BY APPLICABLE LAW, CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS DOCUMENT OR ANY SOFTWARE OR ACCOMPANYING HARDWARE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. No computing device can be absolutely secure. Therefore, despite security measures implemented in Cypress hardware or software products, Cypress shall have no liability arising out of any security breach, such as unauthorized access to or use of a Cypress product. CYPRESS DOES NOT REPRESENT, WARRANT, OR GUARANTEE THAT CYPRESS PRODUCTS, OR SYSTEMS CREATED USING CYPRESS PRODUCTS, WILL BE FREE FROM CORRUPTION, ATTACK, VIRUSES, INTERFERENCE, HACKING, DATA LOSS OR THEFT, OR OTHER SECURITY INTRUSION (collectively, "Security Breach"). Cypress disclaims any liability relating to any Security Breach, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any Security Breach. In addition, the products described in these materials may contain design defects or errors known as errata which may cause the product to deviate from published specifications. To the extent permitted by applicable law, Cypress reserves the right to make changes to this document without further notice. Cypress does not assume any liability arising out of the application or use of any product or circuit described in this document. Any information provided in this document, including any sample design information or programming code, is provided only for reference purposes. It is the responsibility of the user of this document to properly design, program, and test the functionality and safety of any application made of this information and any resulting product. "High-Risk Device" means any device or system whose failure could cause personal injury, death, or property damage. Examples of High-Risk Devices are weapons, nuclear installations, surgical implants, and other medical devices. "Critical Component" means any component of a High-Risk Device whose failure to perform can be reasonably expected to cause, directly or indirectly, the failure of the High-Risk Device, or to affect its safety or effectiveness. Cypress is not liable, in whole or in part, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any use of a Cypress product as a Critical Component in a High-Risk Device. You shall indemnify and hold Cypress, including its affiliates, and its directors, officers, employees, agents, distributors, and assigns harmless from and against all claims, costs, damages, and expenses, arising out of any claim, including claims for product liability, personal injury or death, or property damage arising from any use of a Cypress product as a Critical Component in a High-Risk Device. Cypress products are not intended or authorized for use as a Critical Component in any High-Risk Device except to the limited extent that (i) Cypress’s published data sheet for the product explicitly states Cypress has qualified the product for use in a specific High-Risk Device, or (ii) Cypress has given you advance written authorization to use the product as a Critical Component in the specific High-Risk Device and you have signed a separate indemnification agreement. | |
| <br> | |
| Cypress, the Cypress logo, and combinations thereof, WICED, ModusToolBox, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress or a subsidiary of Cypress in the United States or in other countries. For a more complete list of Cypress trademarks, visit cypress.com. Other names and brands may be claimed as property of their respective owners. |