Cypress Semiconductor / Mbed OS mbed-os-example-emwin-eink

This code example demonstrates displaying graphics on an EInk display using EmWin graphics library in Mbed OS.

PSoC 6 MCU: emWin E-INK with Mbed OS

This code example demonstrates displaying graphics on an E-INK display using EmWin graphics library in Mbed OS.

Tested with Mbed OS v6.2.1.

Provide feedback on this code example.

Requirements

• Programming Language: C/C++

• Associated Parts: All PSoC® 6 MCU parts

• Mbed CLI

• ModusToolbox® v2.1

Note: You do not need to install ModusToolbox to build and run this code example. However, installing it is required when you need to:

• Debug using the Eclipse IDE for ModusToolbox. See the user guide for details.

• Customize the default device configuration using any of the Configurator tools

• Port this code example to a new target that is not listed under the Supported Kits

Supported Toolchains (Mbed CLI argument -t)

• GNU Arm® Embedded Compiler v9.2.1 (GCC_ARM)
• Arm Compiler v6.14 (ARM)

Supported Kits (Mbed CLI argument -m)

• PSoC 6 BLE Pioneer Kit (CY8CKIT-062-BLE)
• PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT)
• PSoC 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
• PSoC 62S1 Wi-Fi BT Pioneer Kit (CYW9P62S1-43438EVB-01)
• PSoC 62S1 Wi-Fi BT Pioneer Kit (CYW9P62S1-43012EVB-01)
• PSoC 64 Secure Boot Wi-Fi BT Pioneer Kit (CY8CKIT-064B0S2-4343W)

Hardware Setup

This code example requires CY8CKIT-028-EPD E-INK Display Shield. This shield comes with PSoC 6 BLE Pioneer Kit. It can also be purchased standalone and used with other supported kits.

Note: The PSoC 6 BLE Pioneer Kit (CY8CKIT-062-BLE) and the PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. The 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”.

For Mbed OS, the kit must be in DAPLink mode. See the KitProg3 User Guide (see Documentation tab in the Cypress Programming Solutions web page) to learn how to put the Pioneer Kit into DAPLink mode.

Software Setup

Install a terminal emulator if you don’t have one. Instructions in this document use Tera Term.

This example requires no additional software or tools.

Import the Code Example using Mbed CLI

Mbed CLI commands are used to import the code example and compile. See Working with Mbed CLI web page.

mbed import https://github.com/cypresssemiconductorco/mbed-os-example-emwin-eink

This command first clones the code example repository from GitHub, and then deploys all the libraries.

If you wish to perform the deploy process manually, use the following commands:

1. Clone the GitHub code example repository:

git clone https://github.com/cypresssemiconductorco/mbed-os-example-emwin-eink && cd mbed-os-example-emwin-eink

2. Deploy the dependent libraries. The library files are identified with the .lib extension.

mbed deploy

3. Set the current directory as root:

mbed new .

Operation

If using a PSoC 64 Secure MCU kit (like CY8CKIT-064B0S2-4343W), the PSoC 64 Secure MCU must be provisioned with keys and policies before being programmed. Follow the instructions in the Secure Boot SDK User Guide to provision the device. If the kit is already provisioned, copy-paste the keys and policy folder to the application folder.

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

2. Program the board using mbed command to compile and flash the application using the default toolchain to the default target:

   mbed compile -m <TARGET> -t <TOOLCHAIN> --flash --sterm

   For example, to build for the target CY8CKIT-062-BLE with the toolchain GCC_ARM, use the following command:

   mbed compile -m CY8CKIT_062_BLE -t GCC_ARM --flash --sterm

Note: With the --sterm option, Mbed CLI opens a new terminal with 9600-8N1 as the setting after programming completes. Do not use this option if you want to connect using another serial terminal application such as PuTTY or Tera Term.

3. After programming, the application starts automatically. Confirm that the the startup screen with the Cypress logo is displayed on the E-INK display for 3 seconds.

After 3 seconds, another screen with instructions to press the user switch to scroll through the display pages is displayed. The LED is turned on and off when the display is updated with new content.

4. Press the user switch to scroll through various display pages that demonstrate the emWin graphic library’s 2D graphics features:

   • Font sizes - normal fonts
   • Font sizes - bold fonts
   • Text alignments and styles
   • Text wrap and rotation
   • 2D graphics #1
   • 2D graphics #2

Figure 1. Startup Screen

Figure 2. 2D Graphics

Debugging

You can debug the example to step through the code. In the IDE, use the \ Debug (KitProg3_MiniProg4) configuration in the Quick Panel. For more details, see the “Program and Debug” section in the Eclipse IDE for ModusToolbox User Guide.

Follow the steps from Eclipse IDE for ModusToolbox User Guide to export the Mbed OS code example and import it into Eclipse IDE for ModusToolbox for programming and debugging.

Mbed OS also supports debugging using any IDE that supports GDB. See Arm Mbed documentation to learn about debugging steps.

Note: (Only while debugging) On the CM4 CPU, some code in main() may execute before the debugger halts at the beginning of main(). This means that some code executes twice - once before the debugger stops execution, and again after the debugger resets the program counter to the beginning of main(). See KBA231071 to learn about this and for the workaround.

Design and Implementation

This project uses a CY8CKIT-028-EPD E-INK Display Shield together with a Pioneer Board. The E-INK Shield has a 2.7-inch E-INK display with a resolution of 264×176 pixels.

For details on the Pioneer Board and E-INK Display Shield, see the Pioneer Kit Guide.

There are three important parts in this code example:

1. emWin Graphics Library: The emWin Graphics Library is implemented as a middleware and has all the graphics functions. In this example, the library manages a display buffer and updates it with the pixel data in accordance with the graphics operations performed.

See emWin middleware documentation on GitHub to learn about the structure of the emWin package and supported drivers, and for a quick start guide to create and run your first emWin project from scratch. The documentation page also contains configuration details on a wide variety of display drivers provided my emWin.

2. E-INK Driver: The necessary libraries are added through the display-eink-e2271cs021 display library to drive the display. This library provides functions for supporting the EPD display driven by the E2271CS021 controller through the SPI interface. The SPI interface is set to run at 18 MHz.

3. Application Code: The application code calls emWin graphics APIs to perform graphic functions.

Resources and Settings

Table 1. Application Resources

Related Resources

Other Resources

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 History

Document Title: CE223727 - PSoC 6 MCU: emWin E-INK with Mbed OS

All other trademarks or registered trademarks referenced herein are the property of their respective owners.

© Cypress Semiconductor Corporation, 2020. 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.