This application demonstrates a LE Vendor Specific Device. During initialization, the app registers with the LE stack to receive notifications, including bonding complete, connection status change, and peer write. When a device is successfully bonded, the application saves the peer's Bluetooth® Device address to its NVRAM. Bonded devices can also write in to the client configuration descriptor of the notification characteristic. That is also saved in the device's NVRAM. When the user pushes the button, notification/indication is sent to the bonded and registered host. The user can also write to the characteristic configuration value. The number of LED blinks on the board indicates the value written.
- GATT database and device configuration initialization
- Registration with the LE stack for various events
- NVRAM read/write operations
- Sending data to the client
- Processing write requests from the client
To demonstrate the app, work through the following steps:
- Plug the AIROC™ eval board into your computer.
- Build and download the application to the AIROC™ board.
- Pair with a client.
- On the client side, register for notifications.
- Push a button on the board to send notifications to the client.
- Write the hello sensor characteristic configuration value from the client.
- The number of LED blinks on the hello sensor device indicates value written by the client.
- For 20721B2 based AIROC™ kits, use the Custom button on audio shield board as application button rather than the button on the base board.
This application demonstrates link key storage for one device at a time, using one VS_ID to store in NVRAM, meaning that if a second device is paired, it will overwrite the key of the first device. To support multiple concurrent pairings, additional VS_IDs can be implemented and managed to store the number of keys needed, or key storage could be handled by an external host. Note: devices with BTSTACK version 1 also store paired devices in RAM, which is available only until the device is reset. Applications should not rely on that, only pairings that are stored in NVRAM persist across device resets.
The CYW920835M2EVB-01 is used without an audio shield board and the User button is configured for input by default.
The CYW920835M2EVB-01 and CYW955513EVK-01 kits can use the btsdk-driver library component nvram_emulation to demonstrate key storage without using flash. Use the library-manager tool to add the btsdk-drivers library to this app to get started. See the btsdk-drivers/COMPONENT_nvram_emulation/readme.txt for further details. After enabling DIRECT_LOAD=1 (for 20835), NVRAM_EMULATION, NVRAM_EMULATION_HCI, and ENABLE_HCI_TRACE in the application makefile, build and program the app to the kit.
Use the "nvram_emulation_backup.py" script provided with the nvram_emulation library to demonstrate host nvram backup via HCI to a file "nvram.json". See the instructions in btsdk-drivers/COMPONENT_nvram_emulation/readme.txt on how to use the scipt to show a power loss and recovery of the emulated nvram data. For hello_sensor, follow these steps:
- Start from a clean state: delete nvram.json and forget any pairing keys in the peer Bluetooth device. See instructions in btsdk-drivers/COMPONENT_nvram_emulation/readme.txt to erase real nvram if the kit includes it.
- Build the app with the nvram emulation library and DIRECT_LOAD=1, NVRAM_EMULATION=1, and NVRAM_EMULATION_HCI=1 in the makefile.
- Program the app to the kit.
- Run the script to restore any previous nvram. If any nvram items are restored the script will show "sent nvram backup restore" in the script console output.
- The app starts up advertising, so a phone can be connected to "Hello" with a phone app like LightBlue or AIROC Connect. If Notifications are enabled in the phone app, the phone will request to pair with the app. Accept and observe the script will show nvram is updated with HELLO_SENSOR_PAIRED_KEYS_VS_ID (0x202).
- Simulate a power failure by diconnecting from "Hello" with the phone app, quitting the script (Ctrl-c), and removing power from the kit.
- Restore power to the kit and resume the application by Recovery Reset and programming the app to the kit.
- Run the script to restore the nvram state previous to the power removal.
- Resume operation with the phone and re-connect to "Hello". Again enable Notifications in the phone app. This time the phone will not need to re-pair with the app. The pairing keys have been restored from backup via HCI.
The CYW955572BTEVK-01 is used with the audio shield board and the CUSTOM button on the shield board is configured for input by default. The CYW943022BTEVK-01 needs the following fly-wiring for the LED1 and user button to work: LED1: Connect (J4, D7) to LED1 (J11, pin 2) User Button: Connect (J3, SDA) to (J12, pin 1)
The application device name can be changed in command line with APP_NAME=xxxxxxxx option. The maximum application device name is 8 characters and no space is allowed. The default name is Hello.
Build command example: $ make program APP_NAME=Hello123
BTSDK AIROC™ chips contain the embedded AIROC™ Bluetooth® stack, BTSTACK. Different chips use different versions of BTSTACK, so some assets may contain variant sets of files targeting the different versions in COMPONENT_btstack_vX (where X is the stack version). Applications automatically include the appropriate folder using the COMPONENTS make variable mechanism, and all BSPs declare which stack version should be used in the BSP .mk file, with a declaration such as:
COMPONENTS+=btstack_v1
or:
COMPONENTS+=btstack_v3
Application settings below are common for all BTSDK applications and can be configured via the makefile of the application or passed in via the command line.
Set the BDA (Bluetooth® Device Address) for your device. The address is 6 bytes, for example, 20819A10FFEE. By default, the SDK will set a BDA for your device by combining the 7 hex digit device ID with the last 5 hex digits of the host PC MAC address.
Set to the UART port you want to use to download the application. For example 'COM6' on Windows or '/dev/ttyWICED_HCI_UART0' on Linux or '/dev/tty.usbserial-000154' on macOS. By default, the SDK will auto-detect the port.
For HW debugging, configure ENABLE_DEBUG=1. See the document AIROC™-Hardware-Debugging for more information. This setting configures GPIO for SWD.
-
CYW920819EVB-02/CYW920820EVB-02: SWD signals are shared with D4 and D5, see SW9 in schematics.
-
CYBT-213043-EVAL/CYBT-253059-EVAL: SWD signals are routed to P12=SWDCK and P13=SWDIO. Use expansion connectors to connect VDD, GND, SWDCK, and SWDIO to your SWD Debugger probe.
-
CYBT-223058-EVAL/CYW920835M2EVB-01/CYBT-243053-EVAL/CYBLE-343072-EVAL-M2B/CYBLE-333074-EVAL-M2B/CYBLE-343072-MESH/Vela-IF820-INT-ANT-DVK/Vela-IF820-EXT-ANT-DVK: SWD signals are routed to P02=SWDCK and P03=SWDIO. Use expansion connectors to connect VDD, GND, SWDCK, and SWDIO to your SWD Debugger probe.
-
CYBT-263065-EVAL/CYBT-273063-EVAL: SWD signals are routed to P02=SWDCK and P04=SWDIO. Use expansion connectors to connect VDD, GND, SWDCK, and SWDIO to your SWD Debugger probe.
-
CYBT-343026-EVAL/CYBT-353027-EVAL/CYBT-333047-EVAL: SWD signals are routed to P11=SWDCK and P15=SWDIO. Use expansion connectors to connect VDD, GND, SWDCK, and SWDIO to your SWD Debugger probe.
-
CYBT-413055-EVAL/CYBT-413061-EVAL: SWD signals are routed to P16=SWDCK and P17=SWDIO. Use expansion connectors to connect VDD, GND, SWDCK, and SWDIO to your SWD Debugger probe.
-
CYW989820EVB-01: SWDCK (P02) is routed to the J13 DEBUG connector, but not SWDIO. Add a wire from J10 pin 3 (PUART CTS) to J13 pin 2 to connect GPIO P10 to SWDIO.
-
CYW920719B2Q40EVB-01: PUART RX/TX signals are shared with SWDCK and SWDIO. Remove RX and TX jumpers on J10 when using SWD. PUART and SWD cannot be used simultaneously on this board unless these pins are changed from the default configuration.
-
CYW920721M2EVK-02/CYW920721M2EVB-03: The default setup uses P03 for SWDIO and P05 for SWDCK. Check the position of SW15 if using JLink with the DEBUG connector.
-
CYW920706WCDEVAL: SWD debugging requires fly-wire connections. The default setup P15 (J22 pin 3 or J24 pin 1) for SWDIO and P11 (J23 pin 5 or J22 pin 4) for SWDCK.
-
CYW920736M2EVB-01: SWD hardware debugging requires fly-wire connections. The only option is using P14 for SWDCK and P15 for SWDIO. These route to Arduino header J2, A1 and A0. These can be fly-wired to Arduino header J4, D4 and D5. From there the signals connect to the KitProg3 SWD bridge. In addition, the debug macros (SETUP_APP_FOR_DEBUG_IF_DEBUG_ENABLED and BUSY_WAIT_TILL_MANUAL_CONTINUE_IF_DEBUG_ENABLED) are placed in sparinit.c in code common to all applications for this device. Most applications for this device call bleprofile_GPIOInit() in subsequent code, overwriting the SWD pin configuration. To use hardware debugging after the call to bleprofile_GPIOInit(), place the debug macros in code after that call.
-
CYW943012B2EVK-01: SWD signals are shared with D4 and D5.
-
CYW920820M2EVB-01 & CYW920819M2EVB-01: The default setup uses P03 for SWDIO and P02 for SWDCK. Check the position of SW15 if using JLink with the DEBUG connector.
-
CYW989820M2EVB-01: SWD hardware debugging requires a fly-wire connection to use P14 for SWDIO. P2 is connected directly to SWDCK / ARD_D4. Fly-wire P14 / ARD_D8 on J3.10 to J4.3 / ARD_D5 to connect SWDIO.
-
SWD hardware debugging is not supported on the following:
- CYW920721M2EVK-01
- CYW920835REF-RCU-01
- CYW9M2BASE-43012BT
- CYBT-423054-EVAL
- CYBT-423060-EVAL
- CYBT-483056-EVAL
- CYBT-483062-EVAL
- CYW955572BTEVK-01
- CYW943022BTEVK-01
BTSDK chips support downloading applications either to FLASH storage or to RAM storage. Some chips support only one or the other, and some chips support both.
If a chip only supports one or the other, this variable is not applicable, applications will be downloaded to the appropriate storage supported by the device.
If a chip supports both FLASH and RAM downloads, the default is to download to FLASH, and the DIRECT_LOAD make variable may be set to 1 in the application makefile (or in the command line make command) to override the default and download to RAM.
Currently, the following chips support both FLASH and RAM download and can set DIRECT_LOAD=1 if desired:
- CYW20835
- CYW20706
Using the ModusToolbox™ Eclipse IDE
- Install ModusToolbox™ 2.4.1 (or higher).
- In the ModusToolbox™ Eclipse IDE, click the New Application link in the Quick Panel (or, use File > New > ModusToolbox IDE Application).
- Pick your board for BTSDK under AIROC™ Bluetooth® BSPs.
- Select the application in the IDE.
- In the Quick Panel, select Build to build the application.
- To program the board (download the application), select Program in the Launches section of the Quick Panel.
Using command line
- Install ModusToolbox™ 2.4.1 (or higher).
- On Windows, use Cygwin from \ModusToolbox\tools_2.x\modus-shell\Cygwin.bat to build apps.
- Use the tool 'project-creator-cli' under \ModusToolbox\tools_2.x\project-creator\ to create your application.
project-creator-cli --board-id (BSP) --app-id (appid) -d (dir)
See 'project-creator-cli --help' for useful options to list all available BSPs, and all available apps per BSP.
For example:
project-creator-cli --app-id mtb-example-btsdk-empty --board-id CYW920706WCDEVAL -d . - To build the app call make build. For example:
cd mtb-examples-btsdk-empty
make build - To program (download to) the board, call:
make qprogram
- To build and program (download to) the board, call:
make program
Note: make program = make build + make qprogram
If you have issues downloading to the board, follow the steps below:
- Press and hold the 'Recover' button on the board.
- Press and hold the 'Reset' button on the board.
- Release the 'Reset' button.
- After one second, release the 'Recover' button.
Note: this is only applicable to boards that download application images to FLASH storage. Boards that only support RAM download (DIRECT_LOAD) such as CYW9M2BASE-43012BT or CYW943022BTEVK-01 can be power cycled to boot from ROM.
Applications that support OTA upgrade can be updated via the peer OTA app in:
<Workspace Dir>\mtb_shared\wiced_btsdk\tools\btsdk-peer-apps-ota
See the readme.txt file located in the above folder for instructions.
To generate the OTA image for the app, configure OTA_FW_UPGRADE=1 in the app
makefile, or append OTA_FW_UPGRADE=1 to a build command line, for example:
make PLATFORM=CYW920706WCDEVAL OTA_FW_UPGRADE=1 build
This will the generate <app>.bin file in the 'build' folder.
- Dual-mode Bluetooth® stack included in the ROM (BR/EDR and LE)
- Bluetooth® stack and profile level APIs for embedded Bluetooth® application development
- AIROC™ HCI protocol to simplify host/MCU application development
- APIs and drivers to access on-board peripherals
- Bluetooth® protocols include GAP, GATT, SMP, RFCOMM, SDP, AVDT/AVCT, LE Mesh
- LE and BR/EDR profile APIs, libraries, and sample apps
- Support for Over-The-Air (OTA) upgrade
- Device Configurator for creating custom pin mapping
- Bluetooth® Configurator for creating LE GATT Database
- Peer apps based on Android, iOS, Windows, etc. for testing and reference
- Utilities for protocol tracing, manufacturing testing, etc.
- Documentation for APIs, datasheets, profiles, and features
- BR/EDR profiles: A2DP, AVRCP, HFP, HSP, HID, SPP, MAP, PBAP, OPP
- LE profiles: Mesh profiles, HOGP, ANP, BAP, HRP, FMP, IAS, ESP, LE COC
- Apple support: Apple Media Service (AMS), Apple Notification Center Service (ANCS), iBeacon, Homekit, iAP2
- Google support: Google Fast Pair Service (GFPS), Eddystone
- Amazon support: Alexa Mobile Accessories (AMA)
Note: this is a list of all features and profiles supported in BTSDK, but some AIROC™ devices may only support a subset of this list.
- CYW20819A1 chip
- CYW20820A1 chip
- CYW20721B2 chip
- CYW20719B2 chip
- CYW20706A2 chip
- CYW20835B1 chip
- CYW43012C0 chip
- CYW43022C1 chip
- CYW20736A1 chip
- CYW30739A0 chip
- CYW55572A1 chip
All BTSDK code examples need the 'mtb_shared\wiced_btsdk' folder to build and test the apps. 'wiced_btsdk' includes the 'dev-kit' and 'tools' folders. The contents of the 'wiced_btsdk' folder will be automatically populated incrementally as needed by the application being used.
dev-kit
This folder contains the files that are needed to build the embedded Bluetooth® apps.
-
baselib: Files for chips supported by BTSDK. For example CYW20819, CYW20719, CYW20706, etc.
-
bsp: Files for BSPs (platforms) supported by BTSDK. For example CYW920819EVB-02, CYW920706WCDEVAL etc.
-
btsdk-include: Common header files needed by all apps and libraries.
-
btsdk-tools: Build tools needed by BTSDK.
-
libraries: Profile libraries used by BTSDK apps such as audio, LE, HID, etc.
tools
This folder contains tools and utilities need to test the embedded Bluetooth® apps.
-
btsdk-host-apps-bt-ble: Host apps (Client Control) for LE and BR/EDR embedded apps, demonstrates the use of AIROC™ HCI protocol to control embedded apps.
-
btsdk-host-peer-apps-mesh: Host apps (Client Control) and Peer apps for embedded Mesh apps, demonstrates the use of AIROC™ HCI protocol to control embedded apps, and configuration and provisioning from peer devices.
-
btsdk-peer-apps-ble: Peer apps for embedded LE apps.
-
btsdk-peer-apps-ota: Peer apps for embedded apps that support Over The Air Firmware Upgrade.
-
btsdk-utils: Utilities used in BTSDK such as BTSpy, wmbt, and ecdsa256.
See README.md in the sub-folders for more information.
The following tool applications are installed on your computer either with ModusToolbox™, or by creating an application in the workspace that can use the tool.
BTSpy:
BTSpy is a trace viewer utility that can be used with AIROC™ Bluetooth® platforms to view protocol and application trace messages from the embedded device. The utility is located in the folder below. For more information, see readme.txt in the same folder.
This utility can be run directly from the filesystem, or it can be run from the Tools section of the ModusToolbox™ QuickPanel, or by right-clicking a project in the Project Explorer pane and selecting the ModusToolbox™ context menu.
It is supported on Windows, Linux and macOS.
Location: <Workspace Dir>\wiced_btsdk\tools\btsdk-utils\BTSpy
Bluetooth® Classic and LE Profile Client Control:
This application emulates host MCU applications for LE and BR/EDR profiles. It demonstrates AIROC™ Bluetooth® APIs. The application communicates with embedded apps over the "WICED HCI UART" interface. The application is located in the folder below. For more information, see readme.txt in the same folder.
This utility can be run directly from the filesystem, or it can be run from the Tools section of the ModusToolbox™ QuickPanel, or by right-clicking a project in the Project Explorer pane and selecting the ModusToolbox™ context menu.
It is supported on Windows, Linux, and macOS.
Location: <Workspace Dir>\wiced_btsdk\tools\btsdk-host-apps-bt-ble\client_control
LE Mesh Client Control:
Similar to the above app, this application emulates host MCU applications for LE Mesh models. It can configure and provision mesh devices and create mesh networks. The application is located in the folder below. For more information, see readme.txt in the same folder.
This utility can be run directly from the filesystem, or it can be run from the Tools section of the ModusToolbox™ QuickPanel (if a mesh-capable project is selected in the Project Explorer pane), or by right-clicking a mesh-capable project in the Project Explorer pane and selecting the ModusToolbox™ context menu.
The full version is provided for Windows (VS_ClientControl) supporting all Mesh models.
A limited version supporting only the Lighting model (QT_ClientControl) is provided for Windows, Linux, and macOS.
Location: <Workspace Dir>\wiced_btsdk\tools\btsdk-host-peer-apps-mesh\host
Peer apps:
Applications that run on Windows, iOS or Android and act as peer Bluetooth® apps to demonstrate specific profiles or features, communicating with embedded apps over the air.
LE apps location: <Workspace Dir>\wiced_btsdk\tools\btsdk-peer-apps-ble
LE Mesh apps location: <Workspace Dir>\wiced_btsdk\tools\btsdk-host-peer-apps-mesh\peer
OTA apps location: <Workspace Dir>\wiced_btsdk\tools\btsdk-peer-apps-ota
Device Configurator:
Use this GUI tool to create source code for a custom pin mapping for your device. Run this tool from the Tools section of the ModusToolbox™ QuickPanel, or by right-clicking a project in the Project Explorer pane and selecting the ModusToolbox™ context menu.
It is supported on Windows, Linux and macOS.
Note: The pin mapping is based on wiced_platform.h for your board.
Location: <Install Dir>\tools_2.x\device-configurator
Note: Not all BTSDK chips support Device Configurator. BSPs using the following devices do not currently support Device Configurator: CYW20706, CYW20736
Bluetooth® Configurator:
Use this GUI tool to create and configure the LE GATT Database and the BR/EDR SDP Database, generated as source code for your application.
Run this tool from the Tools section of the ModusToolbox™ QuickPanel, or by right-clicking a project in the Project Explorer pane and selecting the ModusToolbox™ context menu.
It is supported on Windows, Linux and macOS.
Location: <Install Dir>\tools_2.x\bt-configurator
To view application traces, there are 2 methods available. Note that the
application needs to configure the tracing options.
- "WICED Peripheral UART" - Open this port on your computer using a serial port
utility such as TeraTerm or PuTTY (usually using 115200 baud rate for non-Mesh apps, and 921600 for Mesh apps).
- "WICED HCI UART" - Open this port on your computer using the Client Control application mentioned above (usually using 3M baud rate). Then run the BTSpy utility mentioned above.
BTSDK BSPs are located in the \mtb_shared\wiced_btsdk\dev-kit\bsp\ folder by default.
The application makefile has a default BSP. See "TARGET". The makefile also has a list of other BSPs supported by the application. See "SUPPORTED_TARGETS". To select an alternative BSP, use Library Manager from the Quick Panel to deselect the current BSP and select an alternate BSP. Then right-click the newly selected BSP and choose 'Set Active'. This will automatically update TARGET in the application makefile.
To create a custom BSP from a BSP template for BTSDK devices, see the following KBA article: KBA238530
The libraries needed by the app can be found in in the mtb_shared\wiced_btsdk\dev-kit\libraries folder. To add an additional library to your application, launch the Library Manager from the Quick Panel to add a library. Then update the makefile variable "COMPONENTS" of your application to include the library. For example:
COMPONENTS += fw_upgrade_lib
BTSDK API documentation is available online
Note: For offline viewing, git clone the documentation repo
BTSDK Technical Brief and Release Notes are available online
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.