/mtb-example-btstack-freertos-ess

This code example demonstrates the implementation of a simple BLE Environmental Sensing Profile.

Primary LanguageCOtherNOASSERTION

Bluetooth® LE environmental sensing service

This code example demonstrates the implementation of a simple Bluetooth® LE environmental sensing profile. It shows how to send environmental parameters like temperature by sending simulated temperature values over the Bluetooth® LE connection using Infineon PSoC™ 6 MCU with AIROC™ Bluetooth® LE, AIROC™ CYW20829, AIROC™ CYW89829 and AIROC™ Wi-Fi & Bluetooth® combo SoCs. Instructions provided in this document are applicable for all supported kits in the ModusToolbox™ software environment.

View this README on GitHub.

Provide feedback on this code example.

Requirements

  • ModusToolbox™ v3.2 or later (tested with v3.2)
  • Programming language: C
  • Board support package (BSP) minimum required version for:
    • PSoC™ 6 MCU: v4.0.0
    • CYW920829M2EVK-02: v2.0.0
    • CYW989829M2EVB-01: v2.0.0
    • CYW989829M2EVB-03: v2.0.0
  • Associated parts: PSoC™ 6 MCU parts with AIROC™ CYW43012 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW43012 Wi-Fi & Bluetooth® combo chip, and AIROC™ CYW20829 Bluetooth® LE SoC

Supported toolchains (make variable 'TOOLCHAIN')

  • GNU Arm® Embedded Compiler v11.3.1 (GCC_ARM) – Default value of TOOLCHAIN
  • Arm® Compiler v6.16 (ARM)
  • IAR C/C++ Compiler v9.30.1 (IAR)

Supported kits (make variable 'TARGET')

Hardware setup

This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.

Note: The PSoC™ 6 Bluetooth® LE Pioneer Kit (CY8CKIT-062-BLE) and the PSoC™ 6 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. ModusToolbox™ 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".

Software setup

See the ModusToolbox™ tools package installation guide for information about installing and configuring the tools package.

This code example consists of two parts: a GAP Peripheral and a GAP Central.

For the Central, 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.

Using the code example

Create the project

The ModusToolbox™ tools package provides the Project Creator as both a GUI tool and a command line tool.

Use Project Creator GUI

  1. 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 ModusToolbox™. For more details, see the Project Creator user guide (locally available at {ModusToolbox™ install directory}/tools_{version}/project-creator/docs/project-creator.pdf).

  2. 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.

  3. 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 "Bluetooth® LE environmental sensing service" application with the desired name "ess" configured for the CY8CKIT-062-WIFI-BT BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id CY8CKIT-062-WIFI-BT --app-id mtb-example-btstack-freertos-ble-ess --user-app-name ess--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 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™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

Open the project

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).

Keil µVision

Double-click the generated {project-name}.cprj file to launch the Keil µVision IDE.

For more details, see the Keil µVision for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_uvision_user_guide.pdf).

IAR Embedded Workbench

Open IAR Embedded Workbench manually, and create a new project. Then select the generated {project-name}.ipcf file located in the project directory.

For more details, see the IAR Embedded Workbench for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_iar_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).

Operation

  1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.

  2. Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.

  3. Program the board using one of the following:

    Using Eclipse IDE

    1. Select the application project in the Project Explorer.

    2. 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 program command 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

    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, the application starts automatically. Confirm that "<CE Title>" is displayed on the UART terminal.

  5. To test using the AIROC™ Bluetooth® Connect App, do the following (see equivalent AIROC™ Bluetooth® Connect App screenshots in Figure 1):

    1. Turn ON Bluetooth® on your Android or iOS device.

    2. Launch the AIROC™ Bluetooth® Connect App.

    3. Press the reset switch on the supported kit to start sending advertisements.

    4. Swipe down on the AIROC™ Bluetooth® Connect App home screen to start scanning for Bluetooth® LE Peripherals; your device ("Thermistor") appears in the AIROC™ Bluetooth® Connect App home screen. Select your device to establish a Bluetooth® LE connection. Once the connection is established, LED1 changes from OFF state to always ON state.

    5. Select Environmental Sensing Service and tap SUBSCRIBE.

      The temperature values will be updated every 5 seconds in representations such as HEX.

    Figure 1. Testing with the AIROC™ Bluetooth® Connect App on android

  6. Use the KitProg3 COM port to view the Bluetooth® stack and application trace messages in the terminal window.

    Figure 2. Log messages on KitProg3 COM port

Debugging

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.

Add the below Note for relevant CEs only, like PSoC 6 MCU based. Remove this note for others.

Note: (Only while debugging) 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.

In other IDEs

Follow the instructions in your preferred IDE.

Design and implementation

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. ModusToolbox™ software stores the device configuration settings of the application in the design.modus file and Bluetooth® configuration settings of the application in the design.cybt file. This file is used by the graphical configurators, which generate the configuration firmware. This firmware is stored in the application’s GeneratedSource folder.

  • Device Configurator: Used to enable/configure the peripherals and the pins used in the application. For detailed information on how to use it, see the Device Configurator guide.

  • Bluetooth® Configurator: Used for generating/modifying the Bluetooth® LE GATT database. For detailed information on how to use it, see the Bluetooth® Configurator guide.

Note: For PSoC™ 6 Bluetooth® LE-based BSPs(CY8CKIT-062-BLE, CY8CPROTO-063-BLE, and 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.

This code example is written in a way that is generic across multiple devices and platforms. The code example application runs on the Arm® Cortex® core of the MCU device. The functionality of the code example will remain the same on all the supported kits; the application was developed using the ModusToolbox™ software.

This application demonstrates the Bluetooth® LE peripheral capability of the supported kit. The simulated temperature value is sent over Bluetooth® LE to a Central device, and to the UART as debug trace messages. This project demonstrates the following features:

  • Bluetooth® LE Environment Sensing Service (ESS) – GATT Read and Notify functionality
  • Debug trace messages
  • Connection with one Central device
  • Connection status indication through LED

The project consists of the following files:

Table 1. Important user-application-related source files

File name Comments
main.c Contains the main() function, which is the entry point for execution of the user application code after device startup.
cycfg_bt_settings.c, cycfg_bt_settings.h Contain the runtime Bluetooth® stack configuration parameters such as device name and advertisement/ connection settings. Note that the name that the device uses for advertising (“Thermistor”) is defined in app_bt_cfg.c.
app_bt_gatt_handler.c, app_bt_gatt_handler.h Contain the code for the Bluetooth® stack GATT event handler functions.
cycfg_gatt_db.c, cycfg_gatt_db.h Contain the GATT database information generated using the Bluetooth® configurator tool. These files reside in the GeneratedSource folder under the application folder.

Flowchart

Figure 3. Bluetooth® LE environmental sensing service application

This flowchart provides an overview of the Environmental Sensing Profile application. The Environmental Sensing Profile in this application consists of one of the Bluetooth® SIG-defined services, namely the "Environment Sensing Service" (ESS). This project implements only the Temperature characteristic from the Environmental Sensing service. This characteristic supports notification and read operations, which allow the GATT Server to send data to the connected GATT Client device whenever new data is available, and a read to be performed from the GATT Client device.

The Bluetooth® Configurator provided by ModusToolbox™ software makes it easier to design and implement the GATT DB. The Bluetooth® Configurator generates the cycfg_gatt_db.c and cycfg_gatt_db.h files. All Environmental Sensing profile-related variables and functions are contained in these files. When the GATT DB is initialized after Bluetooth® stack initialization, all profile-related values will be ready to be advertised to the Central device. See the ModusToolbox™ software Bluetooth® Configurator guide for details.

The code example generates dummy temperature values between 20 degree and 30 degree celsius. Every 5 seconds, the temperature varies by 1 degree celsius. A timer callback gives this simulated temperature value, which is then sent every 5 seconds to the Central device when connected and GATT notifications are enabled by the Central.

When the Peripheral device is connected, LED1 will be ON; when it is disconnected, LED1 will be OFF. To turn the LED ON and OFF, generic GPIO functions are used to drive the output pin HIGH or LOW. The LEDs present in the supported kits are active LOW LEDs, which means that the LED turns ON when the GPIO is driven LOW.

The app_bt_gatt_handler.c and app_bt_gatt_handler.h files handle the functionality of GATT callbacks from the Central device. On receiving a connection request, the Bluetooth® stack gives a GATT event to the application of wiced_bt_gatt_evt_t type.

For example, the LED toggle functionality is implemented in the GATT connection callback. On a disconnection event, the code resets the Client Characteristic Configuration Descriptor (CCCD) value so that on a reconnect event, notifications will be disabled.

In cycfg_bt_settings.c, all the runtime Bluetooth® stack configuration parameters are defined; these will be initialized during Bluetooth® stack initialization. Some of the configurations include the device name, connection interval, advertisement interval, advertisement channels to use, number of client connections, and maximum transmission unit (MTU). You also have the flexibility to configure the buffer pool size, which helps in optimizing the memory and transmission rate depending on the application use case.

The project also contains app_bt_utils.c and app_bt_utils.h which provide APIs to see meaningful messages in debug logs in the debug UART. Most of the status messages the in Bluetooth® stack are represented in enumerated values. These functions allow you to view the respective strings instead of the enumerated values.

This application uses a modified FreeRTOSConfig.h file to work. Here, the configTIMER_TASK_PRIORITY is changed to 6 for the timer task and configTIMER_TASK_STACK_DEPTH is changed to 256. In addition, two other minor modifications are made to the default FreeRTOSConfig.h file.

Related resources

Resources Links
Application notes AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™
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.
Libraries on GitHub mtb-pdl-cat1 – 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 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.

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.

For PSoC™ 6 MCU devices, see How to design with PSoC™ 6 MCU – KBA223067 in the Infineon Developer community.

Document history

Document title: CE230294 – Bluetooth® LE environmental sensing service

Version Description of change
1.0.0 New code example
2.0.0 Code Example updated to support ModusToolbox™ software v2.3.1 and it is not backward compatible with v2.3 and below
3.0.0 Added support for 43439 kit
Updated BSP to 3.0.0
3.1.0 Code example updated
4.0.0 Updated to support ModusToolbox™ software v3.0 and BSPs v4.X
4.1.0 Added support for CYW920829M2EVB-01, CY8CKIT-062-BLE, CY8CPROTO-063-BLE, and CYBLE-416045-EVAL
4.2.0 Added support for CY8CEVAL-062S2-LAI-43439M2 and CY8CPROTO-062S2-43439
4.3.0 Removed CYW920829M2EVB-01 from supported kits
Added support for CYW920829M2EVK-02
4.4.0 Added support for CY8CEVAL-062S2-MUR-4373EM2, CY8CEVAL-062S2-MUR-4373M2
4.5.0 Code example updated
4.5.1 Added support for CYW989829M2EVB-01
4.6.0 Added support for CY8CEVAL-062S2-CYW43022CUB and CY8CKIT-062S2-AI
5.0.0 BSP and BTStack-integration major update for BT Firmware as a separate asset and removal of combo devices as doesn't support fw as separate asset

© Cypress Semiconductor Corporation, 2020-2024. 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.