This app demonstrates the use of a Bluetooth® Headset via the AIROC™ audio libraries. This app also supports the AAC codec for some Bluetooth® devices.
- ModusToolbox™ software v3.1 or later (tested with v3.1) with ModusToolbox™ CYW955513 Early Access Pack for CYW955513EVK-01
- Board support package (BSP) minimum required version for : v0.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)
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 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".
- This application is applicable for CYW955513EVK-01 with version >= REV02.
- This application use the CYW9BTAUDIO5 as the audio codec shield board
Install the BTSpy.
- BTSpy: Bluetooth® Trace through HCI Uart
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}/mt_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 "Hello world" application with the desired name "MyHelloWorld" 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-hal-hello-world --user-app-name MyHelloWorld --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 modlibs 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 |
Following example adds the CYW955513EVK-01 BSP to the already created application and makes it the active BSP for the app:
library-manager-cli --project "C:/mtb_projects/MyHelloWorld" --add-bsp-name CYW955513EVK-01 --add-bsp-version "latest-v4.X" --add-bsp-location "local"
library-manager-cli --project "C:/mtb_projects/MyHelloWorld" --set-active-bsp CYW955513EVK-01
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, and then import the libraries using the
make getlibscommand. -
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).
To demonstrate the app, follow these steps:
- Build and download the application to the AIROC™ board.
- Plug in a wired headset to the "Right-MIC" jack (J10) on the codec shield board
- Press the Custom button to start pairing mode of the headset_speaker, as shown in the following figure:
- Find and pair with the "HSPK" Bluetooth® audio device from your phone.
- Once the process is completed, stream music from your phone to the headset_speaker app.
Application specific settings are as below:
-
SPEAKER
- This option allows the device to enable output on an audio shield board to drive the external speaker on an EVK board if it is supported. By default the option is off.
-
AAC_SUPPORT
- This option allows the device to enable the AAC codec if the Bluetooth® chip supports.
- On CYW955513EVK-01(3 buttons)
Button event: click/ long press/ hold
- Custom: Play, Pause, Accept/ Reject, Discoverable/ -
- Vol+: Volume up/ Next Track/ +
- Vol-: Volume down/ Last Track/ -
-
While testing with PTS for certification test cases, please define ENABLE_PTS_TESTING flag in makefile as shown below. CY_APP_DEFINES += -DENABLE_PTS_TESTING
-
For A2DP/SNK/REL/BV/02-I test case, to initiate disconnection from IUT, please long press and hold the Vol- button
-
For A2DP/SNK/CC/BV-03-I and A2DP/SNK/CC/BV-04-I test cases, 16Khz and 32Khz sampling rate will be supported by defining ENABLE_PTS_TESTING flag
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) On the CM33 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.
BTSpy is a trace utility that can be used in the AIROC™ Bluetooth® platforms to view protocol and generic trace messages from the embedded device. BTSpy is available as part of the ModusToolbox™ installation. If not, download and install BTSpy.
-
Add the
HCI_TRACE_OVER_TRANSPORTmacro in the Makefile or command-lineCY_APP_DEFINES+=HCI_TRACE_OVER_TRANSPORT. -
Call
wiced_hci_trace_enable(); -
Ensure that retarget-io is not enabled on the same UART port as BTSpy. There is no need to initialize the retarget-io library if the application wants to send both application messages and Bluetooth® protocol traces to the same port through BTSpy.
-
Use compiler directives to either initialize the retarget-io library or BTSpy logs depending on the debug macro setting.
For example:
#ifdef HCI_TRACE_OVER_TRANSPORT #define TRANS_UART_BUFFER_SIZE 1024 #define TRANSPORT_BUFFER_SIZE 1500 #define TRANSPORT_BUFFER_COUNT 2 #define TRANSPORT_UART_BAUD_RATE 3000000 typedef wiced_bool_t (*classic_audio_rpc_cback_t)(uint16_t opcode, uint8_t *p_data, uint32_t data_len); #endif
- In the Makefile, set
CY_APP_DEFINES+=HCI_TRACE_OVER_TRANSPORT. - Build and program the board.
- Open ClientControl.
- Set the baud rate to 3000000.
- Deselect flow control.
- Select the port and click Open port.
- Launch BTSpy.
- Press and release the reset button on the board to get BTSpy logs.
- You should see all the application traces and the Bluetooth® HCI messages. These messages help debug the HCI commands issued to the Bluetooth® controller. Application traces indicate the start/stop of advertisements, connection/disconnection, and PHY updates.
Table 1. Application resources
| Resource | Alias/object | Purpose |
|---|---|---|
| HCI-UART (HAL) | cy_retarget_io_uart_obj | UART HAL object used by retarget-io for the Debug UART port |
| LHL GPIO 6 (HAL) | PLATFORM_BUTTON_CUSTOM | User custom button |
| BT GPIO 4 (HAL) | PLATFORM_BUTTON_VOL_UP | Volume+ |
| BT GPIO 5 (HAL) | PLATFORM_BUTTON_VOL_DOWN | Volume- |
| BT GPIO 17 (HAL) | mSPI | SPI interface for cs47l35 dsp (SPI CLK) |
| LHL GPIO 8 (HAL) | mSPI | SPI interface for cs47l35 dsp (SPI MOSI) |
| LHL GPIO 9 (HAL) | mSPI | SPI interface for cs47l35 dsp (SPI MISO) |
| BT GPIO 16 (HAL) | mSPI | SPI interface for cs47l35 dsp (SPI CS) |
| TDM2 SCK | tdm and i2s interface for cs47l35 dsp | |
| TDM2 WS | tdm and i2s interface for cs47l35 dsp | |
| TDM2 DO | tdm and i2s interface for cs47l35 dsp | |
| TDM2 DI | tdm and i2s interface for cs47l35 dsp |
| Resources | Links |
|---|---|
| Device documentation | Contact infineon sales for device documentation |
| Development kits | Contact infineon sales for kit samples |
| Libraries on GitHub | mtb-pdl-cat5 – CYW55513 peripheral driver library (PDL) mtb-hal-cat5 – Hardware abstraction layer (HAL) library retarget-io – Utility library to retarget STDIO messages to a UART port |
| Tools | Eclipse IDE for 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. |
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: CE239135 - Bluetooth® headset-speaker
| Version | Description of change |
|---|---|
| 0.1.0 | New code example |
| 1.0.0 | First release version |
© Cypress Semiconductor Corporation, 2020-2022. 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, 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 www.infineon.com. Other names and brands may be claimed as property of their respective owners.