This code example demonstrates simple UART communication by printing a "Hello World" message on a terminal and blinks an LED using a Timer resource using PSoC® 6 MCU.
- ModusToolbox™ IDE v2.0
- Programming Language: C
- Associated Parts: All PSoC® 6 MCU parts
- PSoC 6 Wi-Fi BT Prototyping Kit (CY8CPROTO-062-4343W) - Default target
- PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WiFi-BT)
- PSoC 6 BLE Pioneer Kit (CY8CKIT-062-BLE)
- PSoC 6 BLE Prototyping Kit (CY8CPROTO-063-BLE)
- PSoC 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
This example uses the board's default configuration. See the kit user guide to ensure the board is configured correctly.
Note: The PSoC 6 BLE Pioneer Kit and the PSoC 6 WiFi-BT Pioneer Kit ship with KitProg2 installed. ModusToolbox software requires KitProg3. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the Firmware Loader GitHub repository. If you do not upgrade, you will see an error like "unable to find CMSIS-DAP device" or "KitProg firmware is out of date".
Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.
-
Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox IDE Application).
-
Pick a kit supported by the code example from the list shown in the IDE Application 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 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, right-click the application name from the Project Workspace window in the IDE, and select ModusToolbox > Library Manager. For more details, see the IDE User Guide: {ModusToolbox install directory}/ide_2.0/docs/mt_ide_user_guide.pdf.
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 source files. If the kit does not have the required resources, the application may not work.
-
In the Starter Application window, choose the example.
-
Click Next and complete the application creation process.
See Importing Code Example into ModusToolbox IDE - KBA225201 for details.
-
Download and unzip this repository onto your local machine, or clone the repository.
-
Open a CLI terminal and navigate to the application folder.
-
Import required libraries by executing the
make getlibscommand.
-
Connect the board to your PC using the provided USB cable through the USB connector.
-
Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.
-
Program the board.
- Select the application project in the Project Explorer.
- In the Quick Panel, scroll down, and click Hello_World Program (KitProg3).
-
From the terminal, execute the
make programcommand to build and program the application using the default toolchain to the default target. You can specify a target and toolchain manually:make program TARGET=<BSP> TOOLCHAIN=<toolchain>Example:
make program TARGET=CY8CKIT-062-WIFI-BT TOOLCHAIN=GCC_ARMNote: Before building the application, ensure that the libs folder contains the BSP file (TARGET_xxx.lib) corresponding to the TARGET. Execute the
make getlibscommand to fetch the BSP contents before building the application.
After programming, the application starts automatically. Confirm that "Hello World!!!" and other text is displayed on the UART terminal as shown in Figure 1.
-
Confirm that the kit LED blinks at 1 Hz (approximately).
-
Press the Enter key. Confirm that the kit LED stops blinking. The terminal displays the message "LED blinking paused".
-
Press the Enter key again. Confirm that the kit LED resumes blinking at 1 Hz (approximately). The message displayed on the terminal is updated to "LED blinking resumed".
-
Steps 5 and 6 can be repeated indefinitely.
You can debug the example to step through the code. In the ModusToolbox IDE, use the Hello_World Debug (KitProg3) configuration in the Quick Panel. See Debugging a PSoC 6 MCU ModusToolbox Project - KBA224621 for details.
Table 1 lists the ModusToolbox resources used in this example, and how they are used in the design.
| Resource | Alias/Object | Purpose |
|---|---|---|
| Timer (HAL) | led_blink_timer | Timer HAL object used for periodic interrupt generation |
| UART (HAL) | cy_retarget_io_uart_obj | UART HAL object used by Retarget-IO for Debug UART port |
| LED (BSP) | CYBSP_USER_LED | User LED to show output |
This example uses the Arm® Cortex®-M4 (CM4) CPU of PSoC 6 MCU to execute two tasks: UART communication and LED control. At device reset, the default Cortex-M0+ (CM0+) application enables the CM4 CPU and configures the CM0+ CPU to go to sleep.
The application uses a UART resource from the Hardware Abstraction Layer (HAL) to print messages in a UART terminal emulator. The UART resource initialization and retargeting of standard IO to the UART port is done using the retarget-io library.
cy_retarget_io_init(CYBSP_DEBUG_UART_TX, CYBSP_DEBUG_UART_RX, CY_RETARGET_IO_BAUDRATE);After using cy_retarget_io_init, messages can be printed on the terminal simply using printf commands.
A Timer HAL resource is configured to generate a periodic interrupt to set a flag, using which an LED is toggled. The timer_init function uses Timer HAL functions cyhal_timer_init, cyhal_timer_configure and cyhal_timer_set_frequency to create a Timer that counts up to LED_BLINK_TIMER_PERIOD = 9999 using a clock configured with a frequency of LED_BLINK_TIMER_CLOCK_HZ = 10000. cyhal_timer_enable_event is used to enable generation of an event on the terminal count and cyhal_timer_register_callback is used to register a callback to the isr_timer function when the event occurs. A flag is set from the ISR, and processed in the main loop to toggle the user LED.
The main loop also looks for user input from the terminal using the HAL function cyhal_uart_getc. When the user presses the Enter key on the terminal, the LED stops blinking. Pressing Enter again resumes LED blinking, and this cycle can be repeated.
| Application Notes | |
|---|---|
| AN228571 – Getting Started with PSoC 6 MCU on ModusToolbox | Describes PSoC 6 MCU devices and how to build your first application with ModusToolbox |
| AN221774 – Getting Started with PSoC 6 MCU on PSoC Creator | Describes PSoC 6 MCU devices and how to build your first application with PSoC Creator |
| AN210781 – Getting Started with PSoC 6 MCU with Bluetooth Low Energy (BLE) Connectivity on PSoC Creator | Describes PSoC 6 MCU with BLE Connectivity devices and how to build your first application with PSoC Creator |
| AN215656 – PSoC 6 MCU: Dual-CPU System Design | Describes the dual-CPU architecture in PSoC 6 MCU, and shows how to build a simple dual-CPU design |
| Code Examples | |
| Using ModusToolbox IDE | Using PSoC Creator |
| Device Documentation | |
| PSoC 6 MCU Datasheets | PSoC 6 Technical Reference Manuals |
| Development Kits | Buy at Cypress.com |
| CY8CKIT-062-BLE PSoC 6 BLE Pioneer Kit | CY8CKIT-062-WiFi-BT PSoC 6 WiFi-BT Pioneer Kit |
| CY8CPROTO-063-BLE PSoC 6 BLE Prototyping Kit | CY8CPROTO-062-4343W PSoC 6 Wi-Fi BT Prototyping Kit |
| CY8CKIT-062S2-43012 PSoC 62S2 Wi-Fi BT Pioneer Kit | |
| Libraries | |
| Cypress Hardware Abstraction Layer Library and docs | psoc6hal on GitHub |
| RetargetIO - Library for redirecting low level IO commands to allow sending messages via standard printf/scanf functions over a UART connection | retarget-io on GitHub |
| Middleware | |
| Links to all PSoC 6 Middleware | psoc6-middleware on GitHub |
| Tools | |
| ModusToolbox IDE | The Cypress IDE for PSoC 6 and IoT designers |
| PSoC Creator | The Cypress IDE for PSoC and FM0+ development |
Cypress provides a wealth of data at www.cypress.com to help you select the right device, and quickly and effectively integrate it into your design.
For PSoC 6 MCU devices, see How to Design with PSoC 6 MCU - KBA223067 in the Cypress community.
Document Title: CE221773 - PSoC 6 MCU: Hello World
| Version | Description of Change |
|---|---|
| 1.0.0 | New code example |
All other trademarks or registered trademarks referenced herein are the property of their respective owners.
© Cypress Semiconductor Corporation, 2019. This document is the property of Cypress Semiconductor Corporation and its subsidiaries ("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, its directors, officers, employees, agents, affiliates, 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, Spansion, the Spansion logo, and combinations thereof, WICED, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress in the United States and 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.