This code example demonstrates a LE Vendor Specific Client Device. The Hello Client application is designed to connect to and access the services of the Hello Sensor device. Because handles of the all attributes of the Hello Sensor are well known, the Hello Client does not perform GATT discovery, but uses them directly. In addition, Hello Client allows another central to connect, so the device will behave as a peripheral in one Bluetooth® piconet, and a central in another. To accomplish that, the application can do both advertisements and scans. Hello Client assumes that Hello Sensor advertises a special UUID and connects to the device that publishes it.
This code example requires Bluetooth® LE Hello Sensor for its operation.
Provide feedback on this code example.
- ModusToolbox™ v3.1 or later (tested with v3.1) with ModusToolbox™ CYW955513 Early Access Pack for CYW955513EVK-01
- Board support package (BSP) minimum required version: 0.6.0
- Programming language: C
- Associated parts: CYW955513EVK-01
- GNU Arm® Embedded Compiler v10.3.1 (
GCC_ARM) – Default value ofTOOLCHAIN
- CYW955513EVK-01 Wi-Fi Bluetooth® Prototyping Kit (
CYW955513EVK-01) – Default value ofTARGET
This example uses the kit's default configuration. See the kit user 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. ModusToolbox™ requires KitProg3 with the 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 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".
See the ModusToolbox™ tools package installation guide for information about installing and configuring the tools package.
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.
Figure 1. QR codes for AIROC™ Bluetooth® Connect App
Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.
The ModusToolbox™ tools package provides the Project Creator as both a GUI tool and a command line tool.
Use Project Creator GUI
-
Open the Project Creator GUI tool.
There are several ways to do this, including launching it from the dashboard or from inside the Eclipse IDE. For more details, see the Project Creator user guide (locally available at {ModusToolbox™ install directory}/tools_{version}/project-creator/docs/project-creator.pdf).
-
On the Choose Board Support Package (BSP) page, select a kit supported by this code example. See Supported kits.
Note: To use this code example 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.
-
On the Select Application page:
a. Select the Applications(s) Root Path and the Target IDE.
Note: Depending on how you open the Project Creator tool, these fields may be pre-selected for you.
b. Select this code example from the list by enabling its check box.
Note: You can narrow the list of displayed examples by typing in the filter box.
c. (Optional) Change the suggested New Application Name and New BSP Name.
d. Click Create to complete the application creation process.
Use Project Creator CLI
The 'project-creator-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™ 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™ installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ 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 following example clones the "mtb-example-btstack-threadx-hello-client" application with the desired name "HelloClient" configured for the CYW955513EVK-01 BSP into the specified working directory, C:/mtb_projects:
project-creator-cli --board-id CYW955513EVK-01 --app-id mtb-example-btstack-threadx-hello-client --user-app-name HelloClient --target-dir "C:/mtb_projects"
The 'project-creator-cli' tool has the following arguments:
| Argument | Description | Required/optional |
|---|---|---|
--board-id |
Defined in the field of the BSP manifest | Required |
--app-id |
Defined in the 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 |
Note: The project-creator-cli tool uses the
git cloneandmake getlibscommands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).
After the project has been created, you can open it in your preferred development environment.
Eclipse IDE
If you opened the Project Creator tool from the included Eclipse IDE, the project will open in Eclipse automatically.
For more details, see the Eclipse IDE for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_ide_user_guide.pdf).
Visual Studio (VS) Code
Launch VS Code manually, and then open the generated {project-name}.code-workspace file located in the project directory.
For more details, see the Visual Studio Code for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_vscode_user_guide.pdf).
Command line
If you prefer to use the CLI, open the appropriate terminal, and navigate to the project directory. On Windows, use the command-line 'modus-shell' program; on Linux and macOS, you can use any terminal application. From there, you can run various make commands.
For more details, see the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).
-
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.
-
Launch the BTSpy tool.
-
Open the ClientControl application and make the following settings:
- Set the baud rate to 3000000.
- Deselect flow control.
- Select the serial port and click on an open port.
Note: This CE requires Hello Sensor application as the peer device. Create the CE Hello Sensor and follow the README.md to build and program it to other supported BSPs. If you wish to use more than one Hello Sensor, ensure to use different device address and device names before building the Hello Sensor CE. This is to ensure that the Hello Sensors connected can be differentiated easily.
-
Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.
-
Start the ClientControl and BTSpy applications using the steps from the section above, but do not open any serial port.
-
Program the board using one of the following:
Using Eclipse IDE
-
Select the application project in the Project Explorer.
-
In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).
In other IDEs
Follow the instructions in your preferred IDE.
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 is specified in the application's Makefile but you can override this value manually:make program TOOLCHAIN=<toolchain>Example:
make program TOOLCHAIN=GCC_ARM -
-
After programming, the application starts automatically. Open the serial port using the ClientControl application to observe the messages/HCI traces on the BTSpy application.
-
Ensure that you have programmed Hello Sensor to another supported BSP and the application is advertising with the name Hello.
-
Press the user button on Hello Client to start scanning for the Hello Sensor and connect to it automatically.
-
Press the user button and connect with more Hello Sensor devices, one at a time. This example shows connection with up to three Hello Sensor devices.
-
After Hello Client is connected to at least one Hello Sensor it starts advertisement by default if button press is not detected. Using smart phone installed with AIROC™ Bluetooth® Connect App; scan for Hello Client and issue connection from the phone.
-
After connection and service discovery is complete, you will see three GATT Services. Each service corresponds to Hello Sensors connected to the Hello Client. You can issue 'Read' from AIROC™ Bluetooth® Connect App to the Device Name Characteristic of first service to know the device name of the first Hello Sensor connected. You can use the Device Name Characteristic to identify rest of the Hello Sensors connected.
-
Go to Notify Characteristic of a connected Hello Sensor. Click Read or Start Notify button. This triggers pairing when the phone and Hello Client are not bonded. Accept the pairing request on the phone.
-
You will receive notification from the Hello Sensor through Hello Client to the phone. Press button on the first Hello Sensor and observe the corresponding Notify Characteristic on the phone to get the notification.
-
You can use the Write Characteristic to blink the LED on the Hello Sensor through phone. Choose the Write Characteristic from first service and write a value from 1 - 9 to blink LED on the first Hello Sensor.
You can debug the example to step through the code.
In Eclipse IDE
Use the <Application Name> Debug (KitProg3_MiniProg4) configuration in the Quick Panel. For details, see the "Program and debug" section in the Eclipse IDE for ModusToolbox™ user guide.
Note: (Only while debugging) On the CM4 CPU, some code in
main()may execute before the debugger halts at the beginning ofmain(). 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 ofmain(). See KBA231071 to learn about this and for the workaround.
In other IDEs
Follow the instructions in your preferred IDE.
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 shows Bluetooth® multi-role and multi-connection. The device is configured to act as GAP Peripheral or GAP Central. At GATT layer it acts as Server or Client. Hello Client can connect to three Peripherals and one Central. Use Hello Sensor CE as the peripheral. Smart phones with AIROC™ Bluetooth® Connect App installed can be used as Central device. The CE shows how a central can control and get notifications from multiple peripheral devices with a single connection to Hello Client as shown in Figure 2.
Figure 2. Hello Client block diagram
The example implements three custom GATT services called as "Hello_Sensor 1", "Hello_Sensor 2", and "Hello_Sensor 3" and has three custom characteristics - Notify, Blink, and Device Name.
- Notify Characteristic: Sends a notification to the peer client (smart phone in this case) upon receiving notifications from any of the connected peripherals.
- Blink Characteristic: Used by the peer client (smart phone in this case) to write the number of times the onboard user LED should blink on the peripheral.
- Device Name Characteristic: Stores the device name of the connected peripheral. This can be read by the central and use it to identify the peripheral it wants notifications from or write to.
Figure 3. Hello Client GATT details
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.
After reset, the application starts automatically and initializes the BTSTACK and other device peripherals. Press the user button on the device to start scanning for Hello Sensor peripherals and connect. After Bluetooth® LE connection is established, the device discovers services on the Hello Sensor and sends read request to its attributes. If authentication is required to read the attribute, pairing and bonding takes place. After the link is encrypted, all attributes are read and value is stored in local GATT DB. After the pairing process completes, the peer device's link keys and addresses are stored in the device's flash memory and they are bonded.
The Hello Client device can connect to any central. Advertisements start whenever there is a disconnection from central or a new connection with GAP peripheral is complete. Advertisements stop if a GAP central gets connected. The central device can read/write and get notifications from peripherals through Hello Client.
The user button on the board is configured to trigger an interrupt on the falling edge. The user button has one function: Press and release the button quickly to start high duty scanning.
This section explains the ModusToolbox™ 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™ stores the configuration settings of the application in the design.modus file. This file is used by the Device Configurator that 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 ModusToolbox™ Device Configurator user 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. As explained in the Design and implementation section, the only extra service added is the Immediate Alert Service (IAS). See the Bluetooth® Configurator user guide.
| Resources | Links |
|---|---|
| Code examples | Using ModusToolbox™ on GitHub |
| Development kits | Select your kits from the Evaluation board finder. |
| Tools | ModusToolbox™ – ModusToolbox™ software is a collection of easy-to-use libraries and tools enabling rapid development with Infineon MCUs for applications ranging from wireless and cloud-connected systems, edge AI/ML, embedded sense and control, to wired USB connectivity using PSoC™ Industrial/IoT MCUs, AIROC™ Wi-Fi and Bluetooth® connectivity devices, XMC™ Industrial MCUs, and EZ-USB™/EZ-PD™ wired connectivity controllers. ModusToolbox™ incorporates a comprehensive set of BSPs, HAL, libraries, configuration tools, and provides support for industry-standard IDEs to fast-track your embedded application development. |
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 title: CE239134 – Bluetooth® LE Hello Client
| Version | Description of change |
|---|---|
| 1.0.0 | New code example |
All referenced product or service names and trademarks are the property of their respective owners.
The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc., and any use of such marks by Infineon is under license.
© Cypress Semiconductor Corporation, 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.