The Keyboard application is a single chip SoC. It can be built as a Bluetooth® Low Energy (LE) and/or classic Bluetooth® keyboard application. It provides a turnkey solution using on-chip keyscan HW component. It can operate in both BR/EDR Bluetooth® mode and LE, HID over GATT Profile (HOGP).
When pairing, it operates in BR/EDR mode first. During pairing, if the user restarts pairing again, it switches to LE mode pairing. If the user restarts pairing again during LE mode pairing, it stops pairing. The keyboard will operate in either BR/EDR or LE mode based on the last paired host.
During initialization the app registers with both the LE and BR/EDR stacks, the AIROC™ HID Device Library, and keyscan HW to receive various notifications including bonding complete, connection status changes, peer GATT requests/commands, SDP protocol, and interrupts for key pressed/released.
If the device is not paired, pressing any key will start pairing. When the device is successfully bonded, the app saves the bonded host's information in NVRAM.
When the user presses/releases a key, a key report will be sent to the host. On connection up or battery level changed, a battery report will be sent to the host. When battery level is below shutdown voltage, the device will do critical shutdown. Host can send an LED report to the device to control the LED.
- BR/EDR Bluetooth® operation
- SDP protocol support
- GATT database and device configuration initialization
- Registration with the LE stack for various events
- Sending HID reports to the host
- Processing write requests from the host
- Low power management
- Over the air firmware update (OTAFU)
To demonstrate the app, walk through the following steps:
- Plug the keyboard HW into your computer.
- Build and download the application.
- Unplug the keyboard HW from your computer and power cycle the keyboard HW.
- Press the 'Lock' key to start BR/EDR pairing, then pair with a PC or Tablet. The Lock key is located at the right topmost corner.
- To pair with an LE host, during BR/EDR pairing, press the Lock key again to stop BR/EDR pairing and start LE advertisements.
- Once connected, it becomes the keyboard of the PC or Tablet.
In case you don't have the right hardware, reference keyboard, platform CYW920819REF-KB-01, which is required to support the 8x18 key matrix used, you can build an evaluation board version in conjunction to work with ClientControl. You can choose CYW920819EVB-02, CYW920820EVB-02, or CYW920735Q60EVB-01 platform. In this case, the key-matrix will not be functioning correctly due to the lack of key-matrix pin assignment and eval board peripheral pins conflicts. However, you can test the basic Bluetooth® functions and to mimic sending key reports by using ClientControl.
NOTE: To use ClientControl, make sure you use "TESTING_USING_HCI=1" in the application makefile settings. 208xx and 20735 device firmware behaves differently. The following steps shows how to establish communication between ClientControl and the device.
For 20819/20820 devices:
- Plug the hardware into your computer.
- Build and download the application.
- Run ClientControl.exe.
- Choose 3M as the baud rate and select the serial port in the ClientControl tool window.
- Open the port and then reset the device. Close and re-open the port so the HID tab gets activated.
For 20735/20835 devices:
- Plug the hardware into your computer.
- Build and download the application.
- Run ClientControl.exe.
- Choose 3M as the baud rate and select the serial port in the ClientControl tool window.
- Reset the device. (Press reset button or unplug/plug the USB cable). Within 2 seconds, before the device enters deep sleep, open the port. If the ClientControl HIDD tab is not activated, close the port and repeat step 5. Once the HIDD tab is activated, the HID buttons will become available.
- Click on "Enter Pairing Mode" to start BR/EDR pairing, then pair with a PC or Tablet. The "Enter/Exit Pairing Mode" click button is acting as 'Lock' key on the keyboard. Click on "Exit Pairing Mode" while it is in BR/EDR pairing, it then switches to LE advertising for pairing. Click one more time while it is in LE advertising, it will exit pairing mode.
- Once connected, it becomes the keyboard of the PC or Tablet.
8 Click on the key buttons, to send the key reports. For example to send key down event when key '1' is pushed, report should be:
01 00 00 1e 00 00 00 00 00
When the key is released, it should send all keys up:
01 00 00 00 00 00 00 00 00.
The application GATT database is located in bt/ble.h and the SDP database is located in bt/bredr.h. If you create a GATT or SDP database using Bluetooth Configurator, update the database in the location mentioned above.
-
LE
- Use this option to enable Bluetooth® LE compliant with HID over GATT Profile (HOGP). The following options are available only when LE is enabled.
-
ENDLESS_ADV
- Use this option to enable disconnected endless advertisement. When this option is used, the device will do advertising forever until it is connected. To conserve power, it allows SDS/ePDS and does the advertising in a long interval. If AUTO_RECONNECT option is not set, then pressing a key will try to reconnect and stays in advertising mode forever until it is connected.
-
SKIP_PARAM_UPDATE
- Use this option to skip to sending link parameter update requests. When this option is disabled, if the peer device (central) assigned link parameter is not within the device's preferred range, the device will send a request for the desired link parameter change. This option can be enabled to stop the device from sending the request and accept the given link parameter as is.
- In some OS (peer host), after link is up, it continuously sends different parameters of LINK_PARAM_CHANGE over and over for some time. When the parameter is not in our device preferred range, the firmware was rejecting and renegotiating for new preferred parameters. It can lead up to endless and unnecessary overhead in link parameter changes. Instead of continuously rejecting the link parameter, by using this option, we accept peer requested link parameter as is and start a timer to send the final link parameter change request later when the peer host settles down in link parameter change.
-
ASSYMETRIC_PERIPHERAL_LATENCY
-
Use this option to enable asymmetric peripheral latency.
-
In early days, some HID host devices will always reject HID peripheral's link parameter update request. Because of this, HID device will end up consuming high power when peripheral latency was short. To work around this issue, we use Asymmetric Peripheral Latency method to save power by waking up only at multiple time of the communication anchor point. When this option is enabled,
-
We do not send LL_CONNECTION_PARAM_REQ.
-
We simply start Asymmetric Peripheral Latency by waking up at multiple times of given peripheral latency.
-
Since this is not a standard protocol, we do not recommend enabling this option unless it is necessary to save power to work around some HID hosts.
-
-
LE_LOCAL_PRIVACY
- When enabled, the device uses RPA (Random Private Address). When disabled, the device uses Public static address.
-
BREDR
- Use this option to enable classic BR/EDR.
- Since 20735 devices do not support BREDR, if a 20735 TARGET is used, this option will be forced to turn off.
-
TESTING_USING_HCI
- Use this option for testing with the ClientControl host application. The ClientControl UI can be used to provide input. When this option is enabled, the device will not enter SDS/ePDS for power saving.
-
OTA_FW_UPGRADE
- Use this option for enabling firmware upgrade over the Air (OTA) capability. The peer tool applications in wiced_btsdk\tools\btsdk-peer-apps-ota can be used to upgrade OTA firmware image. The OTA firmware image with extention *.ota.bin is created under the build folder. Due to limited internal FLASH space, the 20819/20820 device must use external FLASH for the OTA firmware upgrade to be functional. OTAFU is not supported in CYW920819EVB-02 and CYW920820EVB-02 targets.
-
OTA_SEC_FW_UPGRADE
- Use this option for secure OTA firmware upgrade. OTA_FW_UPGRADE option must be enabled for this option to take effect. The OTA firmware image with extention *.ota.bin.signed must be used for OTA firmware upgrade. Please follow the instruction in wiced_btsdk\tools\btsdk-peer-apps-ota\readme.txt to create *.ota.bin.signed file image.
-
AUTO_RECONNECT
- Use this option to enable auto reconnect. By enabling this option, the device will always stay connected. If it is disconnected, it try to reconnect until it is connected.
- This option should be used together with ENDLESS_ADV. When this option is enabled, the HID device will always try to maintain connection with the paired HID host; therefore, if the link is down, it will continuously try to reconnect. To conserve power, it should allow entering SDS/ePDS while advertising; thus, the ENDLESS_ADV option should be enabled; otherwise, it may drain the battery quickly if the host was not available to reconnect.
-
SLEEP_ALLOWED
- Use this to set sleep option
-
LED
- Use this option to turn on/off LED function (Useful when turned off for power measurement)
When testing with ClientControl on CYW920819EVB-02, please do not pair to a host that runs ClientControl. You will not see the key presses. The reason is because with CYW920819EVB-02 platform, since the key matrix is disabled, the only way to send a character is by using simulated ClientControl buttons. The moment you click on the key button, Windows will focus on the ClientControl application. The text editor loses focus. The character sent to the host will be delivered to the focused application, ClientControl. ClientControl ignores key '1', '2', '3', or 'a', 'b', 'c'. To send the character to a text editor, you will need another PC (host) to pair to the CYW920819EVB-02 device so when you click on a button in ClientControl, the other PC (host) focused on the text editor application does not lose focus and can receive the key.
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-MESH/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: 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-343052-EVAL: 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-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.
- CYW920735Q60EVB-01: SWD hardware debugging supported. The default setup uses the J13 debug header, P3 (J13 pin 2) for SWDIO and P2 (J13 pin 4) for SWDCK. They can be optionally routed to D4 and D4 on the Arduino header J4, see SW9 in schematics.
- 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: The default setup uses P03 for SWDIO and P02 for SWDCK. Check the position of SW15 if using JLink with the DEBUG connector.
- SWD hardware debugging is not supported on the following:
- CYW920721M2EVK-01
- CYW920835REF-RCU-01
- CYW920819REF-KB-01
- CYW9M2BASE-43012BT
- CYBT-423054-EVAL
- CYBT-423060-EVAL
- CYBT-483056-EVAL
- CYBT-483062-EVAL
- CYW955572BTEVK-01
Using the ModusToolbox™ Eclipse IDE
- Install ModusToolbox™ 2.2 (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.2 (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 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
- CYW20735B1 chip
- CYW20835B1 chip
- CYW43012C0 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
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 Tera Term 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.
Complete BSP
To create and use a complete custom BSP that you want to use in applications, perform the following steps:
-
Select an existing BSP created through ModusToolbox™ Project Creator that you wish to use as a template.
-
Make a copy in the same folder and rename it. For example mtb_shared\wiced_btsdk\dev-kit\bsp\TARGET_mybsp.
Note: This can be done in the system File Explorer and then refresh the workspace in ModusToolbox™ to see the new project. Delete the .git sub-folder from the newly copied folder before refreshing in Eclipse. If done in the IDE, an error dialog may appear complaining about items in the .git folder being out of sync. This can be resolved by deleting the .git sub-folder in the newly copied folder. -
In the new mtb_shared\wiced_btsdk\dev-kit\bsp\TARGET_mybsp\release-vX.X.X\ folder, rename the existing/original (BSP).mk file to mybsp.mk.
-
In the application makefile, set TARGET=mybsp and add it to SUPPORTED_TARGETS.
-
In the application libs folder, edit the mtb.mk file and replace all instances of the template BSP name string with 'mybsp'.
-
Update design.modus for your custom BSP if needed using the Device Configurator link under Configurators in the Quick Panel.
-
Update the application makefile as needed for other custom BSP specific attributes and build the application.
Custom Pin Configuration Only - Multiple Apps
To create a custom pin configuration to be used by multiple applications using an existing BSP that supports Device Configurator, perform the following steps:
- Create a folder COMPONENT_(CUSTOM)_design_modus in the existing BSP folder. For example mtb_shared\wiced_btsdk\dev-kit\bsp\TARGET_CYW920819EVB-02\release-vX.X.X\COMPONENT_my_design_modus
- Copy the file design.modus from the reference BSP COMPONENT_bsp_design_modus folder under mtb_shared\wiced_btsdk\dev-kit\bsp\ and place the file in the newly created COMPONENT_(CUSTOM)_design_modus folder.
- In the application makefile, add the following two lines
DISABLE_COMPONENTS+=bsp_design_modus
COMPONENTS+=(CUSTOM)_design_modus
(for example COMPONENTS+=my_design_modus) - Update design.modus for your custom pin configuration if needed using the Device Configurator link under Configurators in the Quick Panel.
- Building of the application will generate pin configuration source code under a GeneratedSource folder in the new COMPONENT_(CUSTOM)_design_modus folder.
Custom Pin Configuration Only - Per App
To create a custom configuration to be used by a single application from an existing BSP that supports Device Configurator, perform the following steps:
- Create a folder COMPONENT_(BSP)_design_modus in your application. For example COMPONENT_CYW920721M2EVK-02_design_modus
- Copy the file design.modus from the reference BSP under mtb_shared\wiced_btsdk\dev-kit\bsp\ and place the file in this folder.
- In the application makefile, add the following two lines
DISABLE_COMPONENTS+=bsp_design_modus
COMPONENTS+=(BSP)_design_modus
(for example COMPONENTS+=CYW920721M2EVK-02_design_modus) - Update design.modus for your custom pin configuration if needed using the Device Configurator link under Configurators in the Quick Panel.
- Building of the application will generate pin configuration source code under the GeneratedSource folder in your application.
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