This code example demonstrates the implementation of a Bluetooth® LE custom service with Bluetooth® security using AIROC™ CYW20829/CYW89829, PSoC™ 6, and ModusToolbox™ software environment.
Provide feedback on this code example.
- ModusToolbox™ v3.1 or later (tested with v3.1)
- Board support package (BSP) minimum required version for :
- CY8CKIT-062-BLE : v4.0.0
- CY8CPROTO-063-BLE : v4.0.0
- CYBLE-416045-EVAL : v4.0.0
- CYW920829M2EVK-02 : v1.0.1
- CYW989829M2EVB-01 : v1.0.1
- Programming language: C
- Associated parts: AIROC™ CYW20829 Bluetooth® LE SoC, PSoC™ 6 MCU with AIROC™ Bluetooth® LE
- GNU Arm® Embedded Compiler v11.3.1 (
GCC_ARM) - Default value ofTOOLCHAIN - Arm® Compiler v6.16 (
ARM) - IAR C/C++ Compiler v9.30.1 (
IAR)
- AIROC™ CYW20829 Bluetooth® LE evaluation Kit (
CYW920829M2EVK-02) – Default value ofTARGET - AIROC™ CYW89829 Bluetooth® LE evaluation kit (
CYW989829M2EVB-01) - PSoC™ 6 Wi-Fi Bluetooth® Prototyping Kit (
CY8CPROTO-062-4343W) - PSoC™ 6 Wi-Fi Bluetooth® Pioneer Kit (
CY8CKIT-062-WIFI-BT) - PSoC™ 62S2 Wi-Fi Bluetooth® Pioneer Kit (
CY8CKIT-062S2-43012) - PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit (
CYW9P62S1-43438EVB-01) - PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit (
CYW9P62S1-43012EVB-01) - PSoC™ 62S3 Wi-Fi Bluetooth® Prototyping Kit (
CY8CPROTO-062S3-4343W) - PSoC™ 62S2 Evaluation Kit (
CY8CEVAL-062S2,CY8CEVAL-062S2-LAI-4373M2,CY8CEVAL-062S2-LAI-43439M2,CY8CEVAL-062S2-MUR-4373EM2,CY8CEVAL-062S2-MUR-4373M2) - PSoC™ 6 Bluetooth® LE Pioneer Kit (
CY8CKIT-062-BLE) - PSoC™ 6 Bluetooth® LE Prototyping Kit (
CY8CPROTO-063-BLE) - EZ-BLE Arduino Evaluation Board (
CYBLE-416045-EVAL) - PSoC™ 62S2 Wi-Fi Bluetooth® Prototyping Kit (
CY8CPROTO-062S2-43439)
This example uses the kit's default configuration. See the respective kit guide to ensure that the kit is configured correctly.
Note: The PSoC™ 6 Bluetooth® LE pioneer kit (CY8CKIT-062-BLE) and PSoC™ 6 Wi-Fi Bluetooth® pioneer kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. The ModusToolbox™ software requires KitProg3. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the Firmware Loader GitHub repository. If you do not upgrade, you will see an error like "unable to find CMSIS-DAP device" or "KitProg firmware is out of date".
The AIROC™ CYW20829 Bluetooth® kit (CYW920829M2EVK-02) ships with KitProg3 version 2.21 installed. The ModusToolbox™ software requires KitProg3 with latest version 2.40. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the 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".
Download and install the AIROC™ Bluetooth® Connect App for iOS or Android.
Scan the following QR codes from your mobile phone to download the AIROC™ Bluetooth® Connect App.
Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.
Create the project and open it using one of the following:
In Eclipse IDE for ModusToolbox™ software
-
Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox™ Application). This launches the Project Creator tool.
-
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 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.
-
In the Project Creator - Select Application dialog, choose the example by enabling the checkbox.
-
(Optional) Change the suggested New Application Name.
-
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.
-
Click Create to complete the application creation process.
For more details, see the Eclipse IDE for ModusToolbox™ software user guide (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_ide_user_guide.pdf).
In command-line interface (CLI)
ModusToolbox™ software provides the Project Creator as both a GUI tool and the 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 manifest |
Required |
--app-id |
Defined in the <id> field of the CE 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 |
The following example clones the "Bluetooth® LE Hello Sensor" application with the desired name "HelloSensor" configured for the CY8CKIT-062-WIFI-BT BSP into the specified working directory, C:/mtb_projects:
project-creator-cli --board-id CYW989829M2EVB-01 --app-id mtb-example-btstack-freertos-hello-sensor --user-app-name HelloSensor --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 (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf).
To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can invoke the Library Manager GUI tool from the terminal using make library-manager command or use the Library Manager CLI tool "library-manager-cli" to change the BSP.
The "library-manager-cli" tool has the following arguments:
| Argument | Description | Required/optional |
|---|---|---|
--add-bsp-name |
Name of the BSP that should be added to the application | Required |
--set-active-bsp |
Name of the BSP that should be as active BSP for the application | Required |
--add-bsp-version |
Specify the version of the BSP that should be added to the application if you do not wish to use the latest from manifest | Optional |
--add-bsp-location |
Specify the location of the BSP (local/shared) if you prefer to add the BSP in a shared path | Optional |
The following example adds the CY8CPROTO-062-4343W BSP to the already created application and makes it the active BSP for the app:
library-manager-cli --project "C:/mtb_projects/HelloSensor" --add-bsp-name CY8CPROTO-062-4343W --add-bsp-version "latest-v4.X" --add-bsp-location "local"
library-manager-cli --project "C:/mtb_projects/HelloSensor" --set-active-bsp APP_CY8CPROTO-062-4343W
In third-party IDEs
Use one of the following options:
-
Use the standalone Project Creator tool:
-
Launch Project Creator from the Windows Start menu or from {ModusToolbox™ software install directory}/tools_{version}/project-creator/project-creator.exe.
-
In the initial Choose Board Support Package screen, select the BSP, and click Next.
-
In the Select Application screen, select the appropriate IDE from the Target IDE drop-down menu.
-
Click Create and follow the instructions printed in the bottom pane to import or open the exported project in the respective IDE.
-
-
Use command-line interface (CLI):
-
Follow the instructions from the In command-line interface (CLI) section to create the application.
-
Export the application to a supported IDE using the
make <ide>command. -
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 (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf).
-
Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.
-
Use your favorite serial terminal application tool and connect to the KitProg3 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 receiving data: Line Feed(LF) or auto setting
-
Program the board using one of the following:
Using Eclipse IDE for ModusToolbox™ software
-
Select the application project in Project Explorer.
-
In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).
Using CLI
From the terminal, execute the
make programcommand 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 TARGET=CYW920829M2EVK-02 TOOLCHAIN=GCC_ARM -
-
After programming, the application starts automatically. Observe the messages on the UART terminal, and wait for the device to connect with the peer client (for example, the AIROC™ Bluetooth® Connect App). Use the KitProg3 COM port to view the Bluetooth® stack and application trace messages in the terminal window:
Figure 1. Log messages on KitProg3 COM port
-
To test using the AIROC™ Bluetooth® Connect App, do the following (see the equivalent AIROC™ Bluetooth® Connect App screenshots in Figure 2 and Figure 3):
-
Turn ON Bluetooth® on your Android or iOS device.
-
Launch the AIROC™ Bluetooth® Connect App.
-
Swipe down on the AIROC™ Bluetooth® Connect App home screen to start scanning for Bluetooth® LE peripherals; your device (“Hello") appears on the AIROC™ Bluetooth® Connect App home screen. Select your device to establish a Bluetooth® LE connection.
-
In the Services page, choose the first characteristic to enable notifications/indications. Register for notifications or indications. This will, in turn, initiate the pairing process.
-
Press the user button 1 in the kit and observe that notification/indication is being received in the mobile app.
Figure 2. Log messages on KitProg3 COM port
Figure 3. Testing with the AIROC™ Bluetooth® Connect App on Android
-
You can choose the second characteristic, write a numeric value into it, and observe that the user LED on the board will blink as many times as the number written in the 'Blink' characteristic.Note that the numeric value written should range from 0-9 only. Figure 4. Log messages on KitProg3 COM port
-
-
To forget a bonded device, press and hold the user button for more than 10 seconds and then release it. Ensure that the device is not in a connected state before performing this. User LED on the kit will be constantly turned ON for first 5 seconds and it will start blinking for 5 more seconds to indicate that the device is entering new mode.
Figure 5. Log messages on KitProg3 COM port
Note: This feature is available only for CYW920829M2EVK-02 and CYW989829M2EVB-01.
-
Navigate to the application Makefile and open it. Find the Makefile variable
ENABLE_SPY_TRACESand set it to the value 1 as shown:ENABLE_SPY_TRACES = 1 -
Save the Makefile, and then build and program the application to the board.
-
Open the ClientControl application and make the following settings:
- Set the baud rate to 3000000.
- Deselect the flow control checkbox.
- Select the serial port and click on an open port.
-
Launch the BTSpy tool.
-
Press and release the reset button on the board to get the BTSpy logs on the BTSpy tool.
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.
Note: (Only while debugging PSoC™ 6 MCU) On the CM4 CPU, some code in main() may execute before the debugger halts at the beginning of main(). This means that some code executes twice - once before the debugger stops execution, and again after the debugger resets the program counter to the beginning of main(). See KBA231071 to learn about this and for the workaround.
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.
The code example configures the device as a Bluetooth® LE GAP Peripheral and GATT Server. The example implements a custom GATT service called 'Hello_Sensor' service and has two custom characteristics - Notify and Blink. The notify characteristic sends a notification or indication to the peer client device upon button press events. The Blink characteristic is used by the peer client to write the number of times the onboard user LED should blink.
The application uses a UART resource from the Hardware Abstraction Layer (HAL) to print debug messages on a UART terminal emulator. The UART resource initialization and retargeting of standard I/O to the UART port are done using the retarget-io library.
Upon reset, the application starts automatically and initializes BTSTACK and other device peripherals. The device starts to advertise its presence to the peer Central devices. Once a Bluetooth® LE connection is established, the peer client device can register for notifications/indications to be received using the CCCD handle of the Notify characteristic. Because the CCCD handle of the Notify characteristic requires write authentication, an attempt to enable notification/indication will trigger the pairing process at the Central side. Once the pairing process completes, the peer device's link keys and addresses are stored in the device's flash memory and therefore bonded.
The user button on the board is configured to trigger an interrupt on the falling edge. The user button has three functions based on the duration of button press. An onboard LED indicates the type of button press.
-
Short button press: Press and release the button quickly to start undirected high advertisements if no connection exists. If a connection exists and notifications/indications are enabled, sends a notification/indication packet to the peer client device.
-
Button press for 5 seconds: Press and hold the button for 5 seconds to enter pairing mode. In pairing mode, you can connect to a new peer device. An onboard LED turns ON for 5 seconds to indicate when to release the button to enter this mode.
-
Button press for 10 seconds: Press and hold the button for 10 seconds to erase the bonding information from the flash memory of the device. The onboard LED will be constantly turned ON for first 5 seconds and it will start blinking for 5 more seconds to indicate that the device is entering new mode.
Note: The device must be disconnected from the peer client device before erasing the bonding information from the flash memory.
The peer client can also write the number of times the user LED on the board blinks using the Blink characteristic.
Figure 6. Hello Sensor process flowchart
This section explains the ModusToolbox™ software resources and their configurations as used in this code example. Note that all the configurations explained in this section have already been implemented 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. This example uses the default configuration. See the Device Configurator guide.
-
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. The services and characteristics added are explained in the Design and implementation section. See the Bluetooth® Configurator guide.
Note: For PSoC™ 6 Bluetooth® LE-based BSPs (CY8CKIT-062-BLE, CY8CPROTO-063-BLE, CYBLE-416045-EVAL) with support for AIROC™ BTSTACK, if you want to use the bt-configurator tool, select the AIROC™ BTSTACK with Bluetooth® LE only (CYW20829, PSoC™ 6 with CYW43xxx Connectivity device) option from the drop-down to select the device. Do not use the PSoC™ Bluetooth® LE Legacy Stack (PSoC™ 6-BLE) option because it is not compatible with AIROC™ BTSTACK.
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 | This LED will blink the number of times as written by the peer client device |
| GPIO (HAL) | CYBSP_USER_LED2 | This LED serves as an indication for a button press of 10-second duration |
| GPIO (HAL) | CYBSP_USER_BTN | Used to send notifications to the peer client on button press events |
| Resources | Links |
|---|---|
| Application notes | AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™ software AN215656 – PSoC™ 6 MCU: Dual-CPU system design |
| Code examples | Using ModusToolbox™ on GitHub |
| Device documentation | PSoC™ 6 MCU datasheets PSoC™ 6 technical reference manuals AIROC™ CYW20829 Bluetooth® LE SoC |
| Development kits | Select your kits from the Evaluation board finder page |
| Libraries on GitHub | mtb-pdl-cat1 – PSoC™ 6 Peripheral Driver Library (PDL) mtb-hal-cat1 – Hardware Abstraction Layer (HAL) library retarget-io – Utility library to retarget STDIO messages to a UART port |
| Middleware on GitHub | capsense – CAPSENSE™ library and documents psoc6-middleware – Links to all PSoC™ 6 MCU middleware |
| Tools | Eclipse IDE for ModusToolbox™ – 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. |
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.
For PSoC™ 6 MCU devices, see How to design with PSoC™ 6 MCU - KBA223067 in the Infineon Developer community.
Document title: CE235150 – Bluetooth® LE hello sensor
| Version | Description of change |
|---|---|
| 1.0.0 | New code example |
| 2.1.0 | Support for three PSoC™ 6 Bluetooth® LE BSPs Feature addition - long button press to remove bond data from NVRAM kv-store implementation using internal flash Workaround added in the application for Note 2 |
| 3.0.0 | Updated to support ModusToolbox™ software v3.0 and BSPs v4.X |
| 3.1.0 | Introduction of pairing-mode, new button press mode to enter pairing-mode |
| 3.2.0 | Added support for CY8CEVAL-062S2-LAI-43439M2,CY8CPROTO-062S2-43439 |
| 3.3.0 | Removed CYW920829M2EVB-01 from supported kits Added support for CYW920829M2EVK-02 |
| 3.4.0 | Added support for CY8CEVAL-062S2-MUR-4373EM2 and CY8CEVAL-062S2-MUR-4373M2 |
| 3.5.0 | Fix reconnection issue due to duplication of bond data entries(BDA) in NVRAM |
| 3.6.0 | Added support for CYW989829M2EVB-01 |
Notes:
-
Release version v2.0.0 of the CE does not use the bt-configurator tool from ModusToolbox™ to generate Bluetooth® configurations. The bt-configurator 2.40.0 tool does not support generation of configuration files for AIROC™ BTSTACK on PSoC™ 6 Bluetooth® LE devices. The Bluetooth® LE configurations can be found in the configs/bt-configuration folder.
-
A workaround has been provided in app_bt_gatt_handler.c for the known issue (section: v2.3.0) mentioned in Release.md of the psoc6cm0p library. This ensures that the application can connect with different peer devices without having to manually forget the bonding data.
© Cypress Semiconductor Corporation, 2020-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.
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.
Cypress, the Cypress logo, and combinations thereof, 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 www.infineon.com. Other names and brands may be claimed as property of their respective owners.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent