Skip to content
Permalink
master
Switch branches/tags

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-btstack-freertos-cyw20829-mouse/README.md

Go to file
 
 
Cannot retrieve contributors at this time
AIROC™ CYW20829 HID mouse reference solution Requirements Supported kits (make variable 'TARGET') Hardware setup Using the code example Operation Debugging Design and implementation Steps to use the mouse application Test procedure Testing on Windows 10 Testing on Android Testing on iOS Switching host devices Changing DPI mode Steps to enable OTA Resources and settings Related resources Other resources Document history
299 lines (172 sloc) 24.1 KB
Raw Blame
Open in GitHub Desktop

AIROC™ CYW20829 HID mouse reference solution

This reference solution demonstrates the implementation of the AIROC™ CYW20829 HID mouse using the Infineon AIROC™ CYW20829 Bluetooth® LE MCU and ModusToolbox™ software environment.

View this README on GitHub.

Provide feedback on this code example.

Requirements

Supported kits (make variable 'TARGET')

Hardware setup

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

Using the code example

Create the project and open it using one of the following:

In Eclipse IDE for ModusToolbox™ software

  1. Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox™ Application). This launches the Project Creator tool.

  2. Pick a kit supported by the code example from the list shown in the Project Creator - Choose Board Support Package (BSP) dialog. This kit should be AIROC™ LE CYW20829 Mouse.

    When you select a supported kit, the example is reconfigured automatically to work with the kit. To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can use the Library Manager to select or update the BSP and firmware libraries used in this application. To access the Library Manager, click the link from the Quick Panel.

    You can also just start the application creation process again and select a different kit.

    If you want to use the application for a kit not listed here, you may need to update the source files. If the kit does not have the required resources, the application may not work.

  3. In the Project Creator - Select Application dialog, choose the example 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 (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_ide_user_guide.pdf).

In command-line interface (CLI)

ModusToolbox™ software provides the Project Creator as both a GUI tool and the command line tool, "project-creator-cli". The CLI tool can be used to create applications from a CLI terminal or from within batch files or shell scripts. This tool is available in the {ModusToolbox™ software install directory}/tools_{version}/project-creator/ directory.

Use a CLI terminal to invoke the "project-creator-cli" tool. On Windows, use the command line "modus-shell" program provided in the ModusToolbox™ software installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ software tools. You can access it by typing modus-shell in the search box in the Windows menu. In Linux and macOS, you can use any terminal application.

The "project-creator-cli" tool has the following arguments:

Argument Description Required/optional
--board-id Defined in the <id> field of the BSP manifest Required
--app-id Defined in the <id> field of the CE manifest Required
--target-dir Specify the directory in which the application is to be created if you prefer not to use the default current working directory Optional
--user-app-name Specify the name of the application if you prefer to have a name other than the example's default name Optional

The following example clones the "mtb-example-btstack-freertos-cyw20829-mouse" application with the desired name "MouseSolution" configured for the CYW920829-MOUSE BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id CYW920829-MOUSE --app-id mtb-example-btstack-freertos-cyw20829-mouse --user-app-name MouseSolution --target-dir "C:/mtb_projects"

Note: The project-creator-cli tool uses the git clone and make getlibs commands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the ModusToolbox™ software user guide (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf).

To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can invoke the Library Manager GUI tool from the terminal using make library-manager command or use the Library Manager CLI tool "library-manager-cli" to change the BSP.

The "library-manager-cli" tool has the following arguments:

Argument Description Required/optional
--add-bsp-name Name of the BSP that should be added to the application Required
--set-active-bsp Name of the BSP that should be as active BSP for the application Required
--add-bsp-version Specify the version of the BSP that should be added to the application if you do not wish to use the latest from manifest Optional
--add-bsp-location Specify the location of the BSP (local/shared) if you prefer to add the BSP in a shared path Optional

Following example adds the CYW920829-MOUSE BSP to the already created application and makes it the active BSP for the app:

library-manager-cli --project "C:/mtb_projects/MouseSolution" --add-bsp-name CYW920829-MOUSE --add-bsp-version "latest-v4.X" --add-bsp-location "local"

library-manager-cli --project "C:/mtb_projects/MouseSolution" --set-active-bsp APP_CYW920829-MOUSE
In third-party IDEs

Use one of the following options:

  • Use the standalone Project Creator 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.


  • Use command-line interface (CLI):

    1. Follow the instructions from the In command-line interface (CLI) section to create the application.

    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 (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf).

Operation

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

  2. Program the board using one of the following:

    Using Eclipse IDE for ModusToolbox™ software

    1. Select the application project in the Project Explorer.

    2. In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).

    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

  3. After programming, the application starts automatically. Confirm that the LED is ON for two seconds after programming.

Debugging

This example requires additional steps to enable debugging. See the user guide to enable debugging.

You can debug the example to step through the code. In the IDE, use the <Application Name> Debug (KitProg3_MiniProg4) configuration in the Quick Panel. For details, see the "Program and debug" section in the Eclipse IDE for ModusToolbox™ software user guide.

Design and implementation

Steps to use the mouse application

  1. Use MTB or via command line to build and program your application.

  2. The HID mouse starts advertising as "IFX BLE Mouse" at high duty for 60 seconds followed by low duty for 30 seconds, and then the advertisements are turned OFF.

  3. When the advertisements are OFF, press any button or move the mouse to start advertisements and get them discovered by peer devices.

  4. When the mouse is connected to the host and kept idle for more than 10 minutes, it disconnects from the host and moves to a deepsleep state to save battery life. The mouse will come out of this deepsleep state on any motion or button press events and start Bluetooth® LE advertisement to get discovered and connect to the host device again.

  5. When battery capacity is less than 10 percent, the mouse gives a low battery alert by blinking the led ON for 500 ms and OFF for 3 seconds.

  6. When the battery capacity reaches 1 percent, the mouse goes to hibernate mode. To come out of this hibernate state, remove the batteries and insert new batteries to power cycle the mouse.

Note: Power cycle the device after programming in order to enter the DS-RAM power mode.

Test procedure

Testing on Windows 10

  1. Use the slider switch at the bottom side to power ON the mouse. The indication LED turns ON for two seconds and then starts blinking during Bluetooth® LE advertisement.

  2. To pair the mouse with a new host device, press and hold the DPI / pair button below the scroll wheel for 3 seconds. This disconnects the mouse from the current host device if connected to any and starts the undirected Bluetooth® LE advertisement. This will be indicated by the fast blink of the onboard LED.

  3. Navigate to Windows 10 Settings and select Bluetooth & other devices in "Devices" as shown.

  1. Enable the Bluetooth® and click on Add Bluetooth or other device. Ensure your device is advertising at this time.

  1. Click on Bluetooth® to scan for available devices nearby. In the discovered devices list, search for "IFX BLE Mouse". After you click on the device, Windows initiates connection and pairing. After a successful connection, Windows displays a notification that Windows is setting up a device.

  1. After connecting, you will get the following notification on Windows.

You can now use the mouse to move the cursor and use the left, right, and middle button clicks along with scroll wheel functionalities.

Testing on Android

  1. Use the slider switch at the bottom side to power ON the mouse. The indication LED turns ON for two seconds and then starts blinking during Bluetooth® LE advertisement.

  2. To pair the mouse with a new host device, press and hold the DPI / pair button below the scroll wheel for 3 seconds. This disconnects the mouse from the current host device if connected to any and starts the undirected Bluetooth® LE advertisement. This will be indicated by the fast blink of the onboard LED.

  3. Enable Bluetooth® and navigate to Bluetooth Settings. Scan for Bluetooth® devices using the Pair new device option.

  4. IFX BLE Mouse will be listed under available devices. Tap on it and click on the pair button to initiate the pairing request. After successful pairing, the mouse will be ready to use and it will be listed in Connected devices.

Testing on iOS

  1. Use the slider switch at the bottom side to power ON the mouse. The indication LED turns ON for two seconds and then starts blinking during Bluetooth® LE advertisement.

  2. To pair the mouse with a new host device, press and hold the DPI / pair button below the scroll wheel for 3 seconds. This disconnects the mouse from the current host device if connected to any and starts the undirected Bluetooth® LE advertisement. This will be indicated by the fast blink of the onboard LED.

  3. To enable external HID devices to function, users need to enable Assistive Touch from Accessibility settings.

  4. Enable Bluetooth® and navigate to Bluetooth Settings. Scan for Bluetooth® devices using the Pair new device option.

  5. IFX BLE Mouse will be listed under available devices. Tap on it and click on the pair button to initiate the pairing request. Upon successful pairing, the Mouse will be ready to use and it will be listed under Connected devices.

Switching host devices

This is an optional feature in the mouse reference solution. To enable this feature, set the MULTI_DEVICE_FEATURE_ENABLE macro to true in app_config.h file in the app_mouse folder in code. The mouse supports pairing up to three host devices using the multi-device feature.

  1. The host device channel can be switched to the next in cyclic order from 1 to 3 using DPI + Middle + Right button press combination. Start with the DPI button press to avoid visible user actions on the screen if the mouse is already connected to a host device in another channel.

  2. The mouse will start discoverable mode undirected advertisement if no previous host is connected to the selected channel. If a previous host device is paired already in the selection channel, the mouse will start connectable mode undirected advertisement.

  3. To overwrite the current channel to a new host, press and hold the DPI / pair button for 3 seconds. This starts the undirected advertisement and a new host device can be paired to the selected channel.

  4. The mouse will start connectable advertisements to the last connected host device channel if the mouse was repowered.

Changing DPI mode

The mouse provides an option to change the DPI mode of the motion sensor to control the sensitivity of the mouse cursor to motion events.

  1. Click the DPI button below the scroll wheel to change the mouse DPI setting.

  2. The default DPI will be 1026 when the mouse is paired to a host device.

  3. The DPI will cyclically change in the order 1026->1634->836 on each DPI button press. The onboard LED blinks once, twice, or thrice depending on if the selected DPI is 836, 1026, or 1634 respectively.

  4. Configure the DPI mode for each device channel separately.

Steps to enable OTA

Refer OTA_README

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

Related resources

Resources Links
Development kits Select your kits from the Evaluation board finder page
Tools Eclipse IDE for ModusToolbox™ software – ModusToolbox™ software is a collection of easy-to-use software and tools enabling rapid development with Infineon MCUs, covering applications from embedded sense and control to wireless and cloud-connected systems using AIROC™ Wi-Fi and Bluetooth® connectivity devices.

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: CE236670 - AIROC™ CYW20829 HID mouse reference solution

Version Description of change
1.0.0 Beta Release of mouse application. This version is not for production
This version is not backward compatible with previous versions of ModusToolbox™ software
2.0.0 Added Support for CYW20829B0
2.1.0 Code changes for new schematics
3.0.0 Added DSRAM functionlaity
3.1.0 Update list of supported compilers.
4.0.0 BSP and BTStack-integration major update for BT Firmware as a 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, WICED, ModusToolbox, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress or a subsidiary of Cypress in the United States or in other countries. For a more complete list of Cypress trademarks, visit www.infineon.com. Other names and brands may be claimed as property of their respective owners.