Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
mtb-example-btsdk-cyw208xx-keyboard-scanner/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
250 lines (148 sloc)
22.7 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # AIROC™ CYW208xx Bluetooth® devices: HAL keyboard scanner | |
| This code example demonstrates the dedicated keyscan hardware, which processes key press events from proprietary GPIOs (LHL GPIOs) without interrupting the CPU core. This code example also demonstrates low power entry when the system is idle (no activity or keypress) and wake up when there is key press. This code example is developed using ModusToolbox™ software integrated development environment. | |
| Features demonstrated: | |
| 1. Functionality of keyscan with maximum possible buttons (that is, 63 in 7 rows * 9 columns) on CYW9208xxEVB-0X. | |
| 2. Configuring extended power down state (ePDS) low power mode and post wake-up. | |
| [View this README on GitHub.](https://github.com/Infineon/mtb-example-btsdk-cyw208xx-keyboard-scanner) | |
| [Provide feedback on this code example.](https://cypress.co1.qualtrics.com/jfe/form/SV_1NTns53sK2yiljn?Q_EED=eyJVbmlxdWUgRG9jIElkIjoiQ0UyMjk5MjgiLCJTcGVjIE51bWJlciI6IjAwMi0yOTkyOCIsIkRvYyBUaXRsZSI6IkFJUk9DJnRyYWRlOyBDWVcyMDh4eCBCbHVldG9vdGgmcmVnOyBkZXZpY2VzOiBIQUwga2V5Ym9hcmQgc2Nhbm5lciIsInJpZCI6InJhbm0iLCJEb2MgdmVyc2lvbiI6IjIuMC4wIiwiRG9jIExhbmd1YWdlIjoiRW5nbGlzaCIsIkRvYyBEaXZpc2lvbiI6Ik1DRCIsIkRvYyBCVSI6IklDVyIsIkRvYyBGYW1pbHkiOiJCVEFCTEUifQ==) | |
| ## Requirements | |
| - [ModusToolbox™ software](https://www.infineon.com/cms/en/design-support/tools/sdk/modustoolbox-software/) v2.4 or later (tested with v2.4). | |
| - Board support package (BSP) minimum required version: 3.0.0 | |
| - Programming language: C | |
| - Associated parts: [AIROC™ CYW20819 Bluetooth® & Bluetooth® LE system on chip](https://www.infineon.com/dgdl/Infineon-CYW20819_Ultra_Low_Power_Bluetooth_LE_BR_EDR_Bluetooth_5.0_SoC-AdditionalTechnicalInformation-v07_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0ee7dba070bf&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-datasheet), [AIROC™ CYW20820 Bluetooth® & Bluetooth® LE system on chip](https://www.infineon.com/dgdl/Infineon-CYW20820_Ultra_Low_Power_Bluetooth_LE_BR_EDR_Bluetooth_5.0_SoC-AdditionalTechnicalInformation-v06_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0ee7e70770d1&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-datasheet) | |
| ## Supported toolchains (make variable 'TOOLCHAIN') | |
| - GNU Arm® embedded compiler v9.3.1 (`GCC_ARM`) – Default value of `TOOLCHAIN` | |
| ## Supported kits (make variable 'TARGET') | |
| - [CYW920820M2EVB-01 evaluation kit](https://www.infineon.com/cms/en/product/wireless-connectivity/airoc-bluetooth-le-bluetooth-multiprotocol/cyw20820/) (`CYW920820M2EVB-01`) – Default value of `TARGET` | |
| - [CYW920819EVB-02 evaluation kit](https://www.infineon.com/cms/en/product/evaluation-boards/cyw920819evb-02/) (`CYW920819EVB-02`) | |
| - [CYW920820EVB-02 evaluation kit](https://www.infineon.com/cms/en/product/wireless-connectivity/airoc-bluetooth-le-bluetooth-multiprotocol/cyw20820/) (`CYW920820EVB-02`) | |
| ## Hardware setup | |
| This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly. However, some of the default super-muxable functions are remapped to the keyscan hardware block. | |
| ## Software setup | |
| Install a terminal emulator if you don't have one. Instructions in this document use [Tera Term](https://ttssh2.osdn.jp/index.html.en). All other required software comes bundled with the ModusToolbox™ software. | |
| To use a Windows PC as the Bluetooth® LE Central device for the GATT Client application, install [CySmart host emulation tool](https://www.infineon.com/cms/en/design-support/tools/utilities/wireless-connectivity/cysmart-bluetooth-le-test-and-debug-tool/). You will also need [CY5677 CySmart Bluetooth® LE 4.2 USB dongle](https://www.infineon.com/cms/en/product/evaluation-boards/cy5677/). | |
| To use an iOS or Android smartphone as the Bluetooth® LE Central device, download the CySmart app. Scan the following QR codes from your mobile phone to download the CySmart app. | |
|  | |
| This example requires no additional software or tools. | |
| ## Using the code example | |
| Create the project and open it using one of the following: | |
| <details><summary><b>In Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Click the **New Application** link in the **Quick Panel** (or, use **File** > **New** > **ModusToolbox Application**). This launches the [Project Creator](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Project_Creator_Guide_3-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99bcabbd31e5) tool. | |
| 2. 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](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Library_Manager_User_Guide_3-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99ab34b831ce) 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. | |
| 3. In the **Project Creator - Select Application** dialog, choose the **HAL Keyboard Scanner** by enabling the checkbox. | |
| 4. (Optional) Change the suggested **New Application Name**. | |
| 5. 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. | |
| 6. Click **Create** to complete the application creation process. | |
| For more details, see the [Eclipse IDE for ModusToolbox™ software user guide](https://www.infineon.com/dgdl/Infineon-Eclipse_IDE_for_ModusToolbox_User_Guide_1-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99bcb86331e8) (locally available at *{ModusToolbox™ software install directory}/ide_{version}/docs/mt_ide_user_guide.pdf*). | |
| </details> | |
| <details><summary><b>In command-line interface (CLI)</b></summary> | |
| 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. | |
| This tool has the following arguments: | |
| Argument | Description | Required/optional | |
| ---------|-------------|----------- | |
| `--board-id` | Defined in the `<id>` field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required | |
| `--app-id` | Defined in the `<id>` field of the [CE](https://github.com/Infineon?q=ce-manifest&type=&language=&sort=) 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 | |
| <br> | |
| The following example will clone the "[HAL Keyboard Scanner](https://github.com/Infineon/mtb-example-btsdk-cyw208xx-keyboard-scanner)" application with the desired name "MyKeyboardScanner" configured for the *CYW920820M2EVB-01* BSP into the specified working directory, *C:/mtb_projects*: | |
| ``` | |
| project-creator-cli --board-id CYW920820M2EVB-01 --app-id mtb-example-btsdk-cyw208xx-keyboard-scanner --user-app-name MyKeyboardScanner --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](https://www.infineon.com/dgdl/Infineon-ModusToolbox_2.4_User_Guide-Software-v01_00-EN.pdf?fileId=8ac78c8c7e7124d1017ed97e72563632) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| </details> | |
| <details><summary><b>In third-party IDEs</b></summary> | |
| Use one of the following options: | |
| - **Use the standalone [Project Creator](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Project_Creator_Guide_3-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99bcabbd31e5) tool:** | |
| 1. Launch Project Creator from the Windows Start menu or from *{ModusToolbox™ software install directory}/tools_{version}/project-creator/project-creator.exe*. | |
| 2. In the initial **Choose Board Support Package** screen, select the BSP, and click **Next**. | |
| 3. In the **Select Application** screen, select the appropriate IDE from the **Target IDE** drop-down menu. | |
| 4. Click **Create** and follow the instructions printed in the bottom pane to import or open the exported project in the respective IDE. | |
| <br> | |
| - **Use command-line interface (CLI):** | |
| 1. Follow the instructions from the **In command-line interface (CLI)** section to create the application, and then import the libraries using the `make getlibs` command. | |
| 2. Export the application to a supported IDE using the `make <ide>` command. | |
| 3. 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](https://www.infineon.com/dgdl/Infineon-ModusToolbox_2.4_User_Guide-Software-v01_00-EN.pdf?fileId=8ac78c8c7e7124d1017ed97e72563632) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| </details> | |
| ## Operation | |
| 1. Connect the board to your PC using the provided USB cable through the USB connector. | |
| The USB serial interface on the kit provides access to the two UART interfaces of the CYW208xx/CYW207xx device: WICED HCI UART and WICED peripheral. | |
| 2. Open any serial terminal program and select the WICED PUART COM port. Set the serial port parameters to 8N1 and 115200 baud. | |
| 3. Program the board with the *mtb-example-btsdk-cyw208xx-keyboard-scanner* application. | |
| <details><summary><b>Using Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Select the application project in the Project Explorer. | |
| 2. In the **Quick Panel**, scroll down, and click **\<Application Name> Program**. | |
| </details> | |
| <details><summary><b>Using CLI</b></summary> | |
| 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 and target are specified in the application's Makefile but you can override those values manually: | |
| ``` | |
| make program TARGET=<BSP> TOOLCHAIN=<toolchain> | |
| ``` | |
| Example: | |
| ``` | |
| make program TARGET=CYW920820M2EVB-01 TOOLCHAIN=GCC_ARM | |
| ``` | |
| </details> | |
| 4. Following instructions appear on the terminal on application start. | |
| **Figure 1. PUART messages** | |
|  | |
| ## Design and implementation | |
| The objective of the application is to demonstrate how you can make use of the keyboard scanner block available in the CYW20xxx Bluetooth® devices. This application also exhibits the procedure to configure ePDS low power mode when the keyscan block is inactive. This application uses custom board support package (BSP/design.modus) as it overrides the default LHL GPIO pin configurations with the help of super-mux functionality. See the datasheet for more details on super-mux functionality. The application also uses a 100 millisecond timer to track the key pressed time. | |
| The following LHL GPIO pins are configured as keyscan rows and columns: | |
| **Table 1. Mapped rows to GPIO's** | |
| ROW | Mapped Px# | |
| ----|----------- | |
| 0 | P0 | |
| 1 | P1 | |
| 2 | P2 | |
| 3 | P3 | |
| 4 | P4 | |
| 5 | P5 | |
| 6 | P6 | |
| **Table 2. Mapped columns to GPIO's** | |
| COL | Mapped Px# | |
| ----|----------- | |
| 0 | P8 | |
| 1 | P9 | |
| 2 | P10 | |
| 3 | P11 | |
| 4 | P12 | |
| 5 | P13 | |
| 6 | P14 | |
| 7 | P15 | |
| 8 | P17 | |
| 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. Eclipse IDE for ModusToolbox™ software stores the configuration settings of the application in the *design.modus* 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. See the [Device configurator guide](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Device_Configurator_Guide_4-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99ab297631cb&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-files). | |
| - **Bluetooth® configurator:** Used for generating/modifying the Bluetooth® LE GATT database. See the [Bluetooth® configurator guide](https://www.infineon.com/dgdl/Infineon-ModusToolbox_Bluetooth_Configurator_Guide_3-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d718a49017d99aaf5b231be&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-files). | |
| <br> | |
| ## Related resources | |
| Resources | Links | |
| -----------| ---------------------------------- | |
| Application notes | [AN225684](https://www.infineon.com/dgdl/Infineon-AN225684_Getting_Started_with_CYW20819-ApplicationNotes-v02_00-EN.PDF?fileId=8ac78c8c7cdc391c017d0d3674d1669d&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-application_note) – Getting started with CYW208xx | |
| Code examples | [Using ModusToolbox™ software](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) on GitHub <br> [Using Bluetooth® SDK](https://www.infineon.com/cms/en/design-support/software/code-examples/psoc-6-code-examples-for-modustoolbox/bluetooth-sdk-code-examples/?utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-code_example) | |
| Device documentation | [CYW20819 device datasheet](https://www.infineon.com/dgdl/Infineon-CYW20819_Ultra_Low_Power_Bluetooth_LE_BR_EDR_Bluetooth_5.0_SoC-AdditionalTechnicalInformation-v07_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0ee7dba070bf&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-datasheet) <br> [CYW20820 device datasheet](https://www.infineon.com/dgdl/Infineon-CYW20820_Ultra_Low_Power_Bluetooth_LE_BR_EDR_Bluetooth_5.0_SoC-AdditionalTechnicalInformation-v06_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0ee7e70770d1&utm_source=cypress&utm_medium=referral&utm_campaign=202110_globe_en_all_integration-datasheet) | |
| Development kits | Visit https://www.infineon.com/cms/en/product/wireless-connectivity/airoc-bluetooth-le-bluetooth-multiprotocol/ | |
| Libraries on GitHub | [btsdk-drivers](https://github.com/Infineon/btsdk-drivers) – Bluetooth® SDK drivers library <br> [btsdk-mesh](https://github.com/Infineon/btsdk-mesh) – Bluetooth® LE mesh libraries <br> [btsdk-ota](https://github.com/Infineon/btsdk-ota) – Bluetooth® LE OTA libraries <br> [btsdk-ble](https://github.com/Infineon/btsdk-ble) – Bluetooth® LE profile libraries | |
| Tools | [Eclipse IDE for ModusToolbox™ software](https://www.infineon.com/cms/en/design-support/tools/sdk/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. <br> [btsdk-utils](https://github.com/Infineon/btsdk-utils) – Bluetooth® SDK utilities <br> [btsdk-peer-apps-ota](https://github.com/Infineon/btsdk-peer-apps-ota) – Bluetooth® LE OTA peer applications <br> [btsdk-host-peer-apps](https://github.com/Infineon/btsdk-host-peer-apps-mesh) – Bluetooth® LE mesh host and peer applications <br> [btsdk-host-apps-bt-ble](https://github.com/Infineon/btsdk-host-apps-bt-ble) – Bluetooth® and Bluetooth® LE host applications | |
| <br> | |
| ## 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. | |
| ## Document history | |
| Document title: CE229928 - *AIROC™ CYW208xx Bluetooth® devices: HAL keyboard scanner* | |
| Version | Description of change | |
| ------- | --------------------- | |
| 1.0.0 | New code example | |
| 1.1.0 | Folders restructured | |
| 2.0.0 | Updated for ModusToolbox™ software v2.4 <br> This version is not backward compatible with ModusToolbox™ software v2.1 <br> Added CYW920820M2EVB-01 platform support | |
| <br> | |
| --------------------------------------------------------- | |
| © Cypress Semiconductor Corporation, 2019-2021. 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. | |
| <br> | |
| 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. | |
| <br> | |
| 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 cypress.com. Other names and brands may be claimed as property of their respective owners. |