Document # 001-93417 Rev *K

Cypress Semiconductor
198 Champion Court
San Jose, CA 95134-1709
http://www.cypress.com
Copyrights

© Cypress Semiconductor Corporation, 2014-2018. This document is the property of Cypress Semiconductor Corporation and
ed
ed 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),
e
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. 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. Cypress products are not
designed, intended, or authorized for use as critical components in systems designed or intended for the operation of weapons,
weapons systems, nuclear installations, life-support devices or systems, other medical devices or systems (including
resuscitation equipment and surgical implants), pollution control or hazardous substances management, or other uses where the
failure of t
component is any component of a device or system whose failure to perform can be reasonably expected to cause the failure of
the device or system, 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 or related to all Unintended Uses of Cypress products.
You shall indemnify and hold Cypress harmless from and against all claims, costs, damages, and other liabilities, including
claims for personal injury or death, arising from or related to any Unintended Uses of Cypress products.

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.

ide, Document # 001-93417 Rev *K 2

 ............................................................................................................................
...............................................................................................................................................

...............................................................................................................................................
...............................................................................................................................................
...........................................................................................................................................................

.....................................................................................................................
........................................................................................................................................................
................................................................................................................................................
..............................................................................................................................

.........................................................................................................................
..........................................................................................................................................
..................................................................................................................................................
..............................................................................................................................
...............................................................................................................................................
...................................................................................................................................................
...................................................................................................................................................
..................................................................................................................
..............................................................................................................................
.........................................................................................................................................
................................................................................................................................
.......................................................................................................................................
...................................................................................................................................
.......................................................................................................................................................
.......................................................................................................................................................
.....................................................................................................................

..............................................................................................................
.............................................................................................................................
...................................................................................................................................................
...............................................................................................................................................
................................................................................................................................
...................................................................................................................................................
.....................................................................................................................................................
..........................................................................................

, Document # 001-93417 Rev *K 3

PSoC Creator 4.2 ES100 User Guide

............................................................................................................................
...............................................................................................................................
...................................................................................................................................
..................................................................................................................................
.....................................................................................................................
...................................................................................................................
.....................................................................................................................
................................................................................................................................................
..........................................................................................................................

.................................................................................................................
...........................................................................................................................................
..................................................................................................................
...........................................................................................................................................
..............................................................................................................................................
.................................................................................................................................
......................................................................................................................

..................................................................................................................
.....................................................................................................................................................
....................................................................................................................................
....................................................................................................................................
.....................................................................................................................................

..............................................................................................................................
............................................................................................................................
.........................................................................................................................
.................................................................................................
.......................................................................................................................................
................................................................................................................................
......................................................................................................................
.............................................................................................................................
..........................................................................................................................
..................................................................................................................
..................................................................................................
.....................................................................................................

.....................................................................................................................................
............................................................................................................................
.........................................................................................................................
................................................................................................................................

..................................................................................................................................................

..............................................................................................................................

............................................................................................................................................................

, Document # 001-93417 Rev *K 4

1

Getting Started Tutorials to get you started using PSoC Creator.

Understanding PSoC Creator Information and tasks to better understand PSoC Creator.
Using Design Entry Tools Tasks and interface descriptions for the graphical design entry tools.
Building a PSoC Creator Project Topics for configuring and building PSoC Creator projects.
Information and tasks for generating PSoC Creator design files for use
Integrating into 3rd Party IDEs
with a 3rd Party IDE
Programming and Debugging Topics for programming the device and using the debugger.
Completing the Project Topics for finalizing a PSoC Creator design.
Reference Material 3rd party tool chain docs and other reference material.

Revision History
Document Title: PSoC® Guide
Document Number: 001-93417
Revision Date Description of Change
** 7/17/14 New document.
*A 7/25/14 Updates to include references to PSoC 4 BLE and PRoC BLE.
*B 12/12/14 Updated screen captures and Design-Wide Resources section.
*C 5/14/15 Updates for PSoC Creator 3.2 and PSoC 4100M and PSoC 4200M.
*D 9/10/15 Updates for PSoC Creator 3.3 and PSoC 4200L.
*E 12/30/15 Updates for PSoC 3.3 Service Pack 1.
*F 9/9/16 Updates for PSoC Creator 4.0.
*G 4/13/17 Updates for PSoC Creator 4.1.
*H 8/25/17 Updates for PSoC Creator 4.2 Beta release.

, Document # 001-93417 Rev *K 5

Welcome to PSoC Creator

Document Title: PSoC® Guide

Document Number: 001-93417
Revision Date Description of Change
*I 12/18/17 Updates for PSoC Creator 4.2 Beta 2 release.
*J 2/14/18 Updates for PSoC Creator 4.2 Production release.
*K 2/26/18 Minor doc edit.

, Document # 001-93417 Rev *K 6

2

Design Tutorials

Beginner:

Intermediate:

Advanced:

, Document # 001-93417 Rev *K 7

Getting Started

See Also:

My First Design "Hello World Blinky"

Create a New Project:

1.

2.

3.

4.

5.

6.

, Document # 001-93417 Rev *K 8

 Getting Started

, Document # 001-93417 Rev *K 9

Getting Started

Add/Configure Components:

1.

, Document # 001-93417 Rev *K 10

 Getting Started

2.

3.

, Document # 001-93417 Rev *K 11

Getting Started

4.

5.

, Document # 001-93417 Rev *K 12

 Getting Started

6.

Assign Pin:

1.

2.

Write C Code:
1.

2.

, Document # 001-93417 Rev *K 13

Getting Started

Program the Device:

1.

2.

3.

4.

Expand the Design:

1.

2.

3.

4.

See Also:

ide, Document # 001-93417 Rev *K 14

 Getting Started

Code Examples

To Use Code Example Projects:

1.

2.

3.

, Document # 001-93417 Rev *K 15

Getting Started

4.

5.

6.

, Document # 001-93417 Rev *K 16

 Getting Started

7.

See Also:

My Templates

To Specify the My Templates Location:

, Document # 001-93417 Rev *K 17

Getting Started

To Copy a Project to My Templates:

To Create a Project from My Templates:

1.

2.

PS , Document # 001-93417 Rev *K 18

 Getting Started

3.

Basic Design

Create a New Project:

Select and Configure Digital Components:

1.

, Document # 001-93417 Rev *K 19

Getting Started

2.

3.

4.

, Document # 001-93417 Rev *K 20

 Getting Started

5.

6.
Instance Parameter(s)

Control_Reg_1 NumOutputs: 2

Clock_1 Desired Frequency: 800 Khz

7.

Select and Configure Analog Components:

1.

, Document # 001-93417 Rev *K 21

Getting Started

2.

3.

, Document # 001-93417 Rev *K 22

 Getting Started

4.

5.

Edit Source Code:

1.

2.

3.

, Document # 001-93417 Rev *K 23

Getting Started

, Document # 001-93417 Rev *K 24

 Getting Started

Build the Project:

, Document # 001-93417 Rev *K 25

Getting Started

Next Steps:

Debugging a Design

Open Example Design:

Set Breakpoints and Step:

1.

2.

3.

, Document # 001-93417 Rev *K 26

 Getting Started

4.

5.

6.

, Document # 001-93417 Rev *K 27

Getting Started

7.

Set Hit Count and Variable Watchpoint:

1.

2.

3.

4.

5.

, Document # 001-93417 Rev *K 28

 Getting Started

6.

7.

8.

9.

10.

11.

PSoC® Creat , Document # 001-93417 Rev *K 29

Getting Started

12.

Library Component Project

Create a New Project:

1.

2.

3.

4.

5.

, Document # 001-93417 Rev *K 30

 Getting Started

Add a Shifter Component:

1.

, Document # 001-93417 Rev *K 31

Getting Started

2.

3.

4.

, Document # 001-93417 Rev *K 32

 Getting Started

5.

6.

, Document # 001-93417 Rev *K 33

Getting Started

7.

1.

, Document # 001-93417 Rev *K 34

 Getting Started

2.

3.

4.

5.

6.

7.

, Document # 001-93417 Rev *K 35

Getting Started

1.

2.

3.

4.

, Document # 001-93417 Rev *K 36

 Getting Started

1.

, Document # 001-93417 Rev *K 37

Getting Started

2.

3.

4.

5.

6.

7.

, Document # 001-93417 Rev *K 38

 Getting Started

Using the Library:

Basic Hierarchical Design

Create a New Project:

1.

2.

3.

4.

, Document # 001-93417 Rev *K 39

Getting Started

5.

6.

, Document # 001-93417 Rev *K 40

 Getting Started

Add the Logic Circuit Library:

1.

2.

, Document # 001-93417 Rev *K 41

Getting Started

3.

, Document # 001-93417 Rev *K 42

 Getting Started

Complete the Design:

1.

2.

, Document # 001-93417 Rev *K 43

Getting Started

3.

4.

5.

6.

7.

8.

9.

, Document # 001-93417 Rev *K 44

 Getting Started

10.

Close the Design:

, Document # 001-93417 Rev *K 45

Getting Started

How To

General PSoC Creator Tasks:

Text Editor Tasks:

General Design Entry Tasks: Framework:

Debugger Tasks:

Schematic Editor Tasks:

, Document # 001-93417 Rev *K 46

 Getting Started

Symbol Editor Tasks:

, Document # 001-93417 Rev *K 47

3

Concepts

Workspace/Project

, Document # 001-93417 Rev *K 48

 Understanding PSoC Creator

See Also:

Project Types

See Also:

, Document # 001-93417 Rev *K 49

Understanding PSoC Creator

Component/Instance

See Also:

, Document # 001-93417 Rev *K 50

 Understanding PSoC Creator

General Tasks

, Document # 001-93417 Rev *K 51

Understanding PSoC Creator

Creating a New Project

To Open this Wizard:

, Document # 001-93417 Rev *K 52

 Understanding PSoC Creator

To Create a New Project:

, Document # 001-93417 Rev *K 53

Understanding PSoC Creator

PSoC® C , Document # 001-93417 Rev *K 54

 Understanding PSoC Creator

, Document # 001-93417 Rev *K 55

Understanding PSoC Creator

See Also:

, Document # 001-93417 Rev *K 56

 Understanding PSoC Creator

Opening an Existing Project

To Open this Dialog:

To Open a Project:
1.

2.

de, Document # 001-93417 Rev *K 57

Understanding PSoC Creator

See Also:

Adding a New Workspace/Project Item

To Open the Dialog:

1.

2.

To Add an Item:
1.

, Document # 001-93417 Rev *K 58

 Understanding PSoC Creator

2.

3.

See Also:

, Document # 001-93417 Rev *K 59

Understanding PSoC Creator

Adding an Existing Project Item

To Add an Existing Item:

, Document # 001-93417 Rev *K 60

 Understanding PSoC Creator

See Also:

Assigning a Core in a Multi-Core Design

, Document # 001-93417 Rev *K 61

Understanding PSoC Creator

Cores Property

Processor Property

See Also:

, Document # 001-93417 Rev *K 62

 Understanding PSoC Creator

Writing Code

Embedded Programming with C - Beginners Resources:

Including Code in Generated Source

Macro Callbacks

Merge Regions

, Document # 001-93417 Rev *K 63

Understanding PSoC Creator

See Also:

Archiving a Workspace/Project

To Open the Dialog:

1.

2.

To Archive a Project/Workspace:
1.

, Document # 001-93417 Rev *K 64

 Understanding PSoC Creator

2.

3.

4.

If you choose the bundle option, a workspace will always be archived. If a workspace is selected as a
source, it will be archived. If, however a project is selected, a new workspace will be created that
contains only the project to archive and it will be archived. This is done because there are project
dependencies that are stored on the workspace which need to be included.

Name Enter a name to rename the archived workspace. If zipped, it will also be used as the
zipped file name.

Include standard Cypress libraries Select this check box to include a copy of all Cypress
libraries (CyPrimitives and CyComponentLibrary) in the archive. This will add dependencies to
the archived copies, and they will be used prior to the standard Cypress libraries installed on
the machine.

5.

6.

See Also:

Saving a Project As

, Document # 001-93417 Rev *K 65

Understanding PSoC Creator

To Save a Project As:

See Also:

Generating a Project Datasheet

, Document # 001-93417 Rev *K 66

 Understanding PSoC Creator

To Generate a Project Datasheet:

1.

2.

3.

See Also:

Generating Description Files

To Enable the Feature (Per Project):

, Document # 001-93417 Rev *K 67

Understanding PSoC Creator

To Generate Description Files:

Command Line

See Also:

, Document # 001-93417 Rev *K 68

 Understanding PSoC Creator

Copying a Project

To Copy a Project:

To Paste a Project:

See Also:

Selecting a Default Compiler

1.

2.

3.

4.

5.

See Also:

, Document # 001-93417 Rev *K 69

Understanding PSoC Creator

Creating a New File

To Open this Dialog:

To Create a New File:

See Also:

PSoC® C , Document # 001-93417 Rev *K 70

 Understanding PSoC Creator

Opening an Existing File

To Open this Dialog:

To Open a File:
1.

2.

See Also:

, Document # 001-93417 Rev *K 71

Understanding PSoC Creator

Creating Folders

Filters:

To Create Physical Folders:

To Create Virtual Folders:

1.

2.

See Also:

, Document # 001-93417 Rev *K 72

 Understanding PSoC Creator

PSoC Creator Framework

Framework Description

de, Document # 001-93417 Rev *K 73

Understanding PSoC Creator

Workspace Explorer:

Document Work Area:

Start Page

Output Window:

Status Bar

See Also:

, Document # 001-93417 Rev *K 74

 Understanding PSoC Creator

Window Types

Tool windows:

Document windows:

Arranging Windows:

See Also:

, Document # 001-93417 Rev *K 75

Understanding PSoC Creator

Tool Windows

Tool Window Toolbar:

See Also:

, Document # 001-93417 Rev *K 76

 Understanding PSoC Creator

Document Windows

Document Work Area Toolbar:

Document Tab Context Menus:

, Document # 001-93417 Rev *K 77

Understanding PSoC Creator

, Document # 001-93417 Rev *K 78

 Understanding PSoC Creator

To Select Document Windows:

Tab Groups:

Split Windows:

, Document # 001-93417 Rev *K 79

Understanding PSoC Creator

See Also:

Framework Interface Components

, Document # 001-93417 Rev *K 80