Cypress Semiconductor CY8CKIT-142, CY5671 Users Manual
CY8CKIT-042-BLE
Bluetooth® Low Energy (BLE)
Pioneer Kit Guide
Doc. # 001-93731 Rev. *A
Cypress Semiconductor
198 Champion Court
San Jose, CA 95134-1709
Phone (USA): 800.858.1810
Phone (Intnl): +1.408.943.2600
www.cypress.com
Copyrights
© Cypress Semiconductor Corporation, 2014. The information contained here in is sub ject to change wi thout no tice. Cypress
Semiconductor Corporation assumes no responsibility for the us e of any circuitry othe r than circuitry embodied in a Cypress
product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted nor
intended to be used for medical, life support, life saving, critical control or sa fety applicati ons, unless pursu ant to an express
written agreement with Cypress. Furthermore, Cypress does not authorize its products for use as critical components in lifesupport systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The
inclusion of Cypress products in life-support systems application implies that the manufacturer assumes all risk of such use
and in doing so indemnifies Cypress against all charges.
Any Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by
and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty
provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create
derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom
software and or firmware in support of licensee product to be used only in conjunction with a C ypress integrated circuit as
specified in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this
Source Code except as specified above is prohibited without the express written permission of Cypress.
Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS
MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials
described herein. Cypress does not assume any liability arising out of the application or use of any product or circuit
described herein. Cypress does not authorize its products for use as critical components in life-support systems where a
malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress’ product
in a life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies
Cypress against all charges.
Use may be limited by and subject to the applicable Cypress software license agreement.
CySmart, F-RAM, PRoC, Programmable System-on-Chip, and PSoC Creator are trademarks, and PSoC and CapSense are
registered trademarks of Cypress Semiconductor Corporation. All other products and company names mentioned in this
document may be the trademarks of their respective holders.
2
Purchase of I
C components from Cypress or one of its sublicensed Associated Companies conveys a license under the
Philips I2C Patent Rights to use these components in an I2C system, provided that the system conforms to the I2C Standard
Specification as defined by Philips. As from October 1st, 2006 Philips Semiconductors has a new trade name - NXP
Semiconductors.
Flash Code Protection
Cypress products meet the specifications contained in their particular Cypress Datasheets. Cypress believes that its family of
products is one of the most secure families of its kind on the market today, regardless of how they are used. There may be
methods, unknown to Cypress, that can breach the code protection features. Any of these methods, to our knowledge, would
be dishonest and possibly illegal. Neither Cypress nor any other semiconductor manufacturer can guarantee the security of
their code. Code protection does not mean that we are guaranteeing the product as “unbreakable.”
Cypress is willing to work with the customer who is concerned about th e integrity of their co de. Code pr otecti on is constantly
evolving. We at Cypress are committed to continuously improving the code protection features of our products.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 2
Contents
Safety Information 6
1. Introduction 11
1.1 Kit Contents..................................... ... ... ....................................... ... ... ... .... ................11
1.2 Board Details ................................... ... ... ... .... ... ...................................... .... ... ... ... .... ...12
1.3 PSoC Creator™.........................................................................................................15
1.4 Getting Started...........................................................................................................16
1.5 Additional Learning Resources..................... ... ... ... ... .... ... ... ... .... ... ... ... ... .... ... ... ... .... ...16
1.6 Technical Support......................................................................................................18
1.7 Documentation Conventions......................................................................................18
1.8 Acronyms...................................................................................................................19
1.5.1 Beginner Resources.......................................................................................16
1.5.2 Application Notes...........................................................................................16
1.5.3 PSoC Creator Example Projects....................................................................17
1.5.4 Component Datasheets .................................................................................17
1.5.5 Bluetooth Learning Resources.......................................................................17
1.5.6 Learning From Peers .....................................................................................17
1.5.7 Other Related Resources...............................................................................18
2. Software Installation 20
2.1 Before You Begin.......................................................................................................20
2.2 Install Software ..........................................................................................................20
2.3 Uninstall Software......................................................................................................23
3. Kit Operation 24
3.1 Theory of Operation..................... .... ... ... ... .... ... ...................................... .... ... ... ... .... ...24
3.2 BLE Pioneer Kit USB Connection..............................................................................26
3.3 Placing Modules on Baseboard.................................................................................26
3.4 Programming and Debugging BLE Device................................................................27
3.4.1 Programming and Debugging using PSoC Creator.......................................27
3.4.2 Programming using PSoC Programmer.........................................................30
3.5 Updating BLE Dongle for CySmart PC Tool..............................................................33
3.6 USB-UART Bridge................................................................. .... ... ... ... ... .... ... ... ... .... ...36
3.7 USB-I2C Bridge.........................................................................................................37
3.8 Updating the Onboard PSoC 5LP Programmer Firmware.........................................40
3.9 Measure Coin Cell Power Consumption.......... ... ... ... .... ... ... ... .... ... ... ... ... ....................40
4. Example Projects 42
4.1 Using Example Projects.............................................................................................42
4.2 CapSense Slider and LED.........................................................................................47
4.2.1 Project Description............................................................................ ... ... .... ...47
4.2.2 Hardware Connections...................................................................................50
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 3
Contents
4.2.3 Flow Chart......................................................................................................51
4.2.4 Verify Output..................................................................................................52
4.3 CapSense Proximity ..................................................................................................62
4.3.1 Project Description............................................................................ ... ... .... ...62
4.3.2 Hardware Connections...................................................................................64
4.3.3 Flow Chart......................................................................................................66
4.3.4 Verify Output..................................................................................................67
4.4 BLE Central Mode .....................................................................................................73
4.4.1 Project Description............................................................................ ... ... .... ...73
4.4.2 Hardware Connections...................................................................................76
4.4.3 Flow Chart......................................................................................................77
4.4.4 Verify Output..................................................................................................78
4.5 BLE Dongle and LED Control....................................................................................81
4.5.1 Project Description............................................................................ ... ... .... ...81
4.5.2 Hardware Connections...................................................................................82
4.5.3 Flow Chart......................................................................................................83
4.5.4 Verify Output..................................................................................................84
4.6 Direct Test Mode (DTM)............................................................................................84
4.6.1 Project Description............................................................................ ... ... .... ...84
4.6.2 Hardware Connection ....................................................................................86
4.6.3 Verify Output..................................................................................................87
5. Hardware 88
5.1 Pioneer Baseboard....................................................................................................88
5.1.1 PSoC 5LP ......................................................................................................88
5.1.2 Power System................................................................................................88
5.1.3 Programming Interface...................................................................................94
5.1.4 Expansion Connectors................................................................... ... ... ... .......95
5.1.5 USB Mini-B Connector................................................................................ ...98
5.1.6 CapSense Circuit...........................................................................................99
5.1.7 Pioneer Board LEDs ....................................................................................101
5.1.8 Push Buttons................................................................................................102
5.1.9 Cypress Ferroelectric RAM (F-RAM) ...........................................................103
5.1.10 Serial Interconnection Between PSoC 5LP and BLE Module......................104
5.1.11 Bluetooth Module Headers...........................................................................105
5.2 BLE Module Board...................................................................................................106
5.2.1 PSoC 4 BLE or PRoC BLE ..........................................................................106
5.2.2 Bluetooth Module Headers (20-Pin and 24-Pin Headers). ... ... ... .... ... ... ... .... .107
5.2.3 Wiggle Antenna............................................................................................108
5.2.4 Antenna Matching Network.................................. ... ... .... ... ... ... ... .... ... ... ... .... .109
5.2.5 BLE Passives...............................................................................................110
5.2.6 Test Points............... ... ... ... .... ... ... ... ....................................... ... ... .... ... ... ........111
5.3 BLE Dongle Board...................................................................................................111
5.3.1 Power System..............................................................................................112
5.3.2 USB Type A Plug.... ... ....................................... ... ... ... .... ... ... ... ... ..................113
5.3.3 User LED......................................................................................................114
6. Advanced Topics 115
6.1 Using PSoC 5LP as USB-UART Bridge ..................................................................115
6.2 Using PSoC 5LP as USB-I2C Bridge ......................................................................126
6.3 Developing Applications for PSoC 5LP ...................................................................134
6.3.1 Building a Bootloadable Project for PSoC 5LP. ... ... ... .... ... ... ........................134
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 4
Contents
6.3.2 Building a Normal Project for PSoC 5LP......................................................143
6.4 PSoC 5LP Factory Program Restore Instructions ...................................................144
6.4.1 PSoC 5LP is Programmed with a Bootloadable Application........................144
6.5 Using FM24V10 F-RAM...........................................................................................150
6.5.1 Address Selection........................................................................................151
6.5.2 Write/Read Operation ..................................................................................151
6.6 CySmart iOS/Android Application............................................................................152
6.7 CySmart PC Tool.....................................................................................................160
A. Appendix 168
A.1 Schematics ..............................................................................................................168
A.2 Board Layout ...... ... ... ... ... ....................................... ... .... ... ... ... .... ... ... ... ... .... ... ...........176
A.3 Bill of Materials (BOM).............................................................................................184
A.4 KitProg Status LED States.......................................................................................194
A.5 Adding BLE module compatible headers on your own baseboard..........................195
Revision History 196
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 5
Safety Information
The CY8CKIT-042-BLE boards contain electrostatic discharge (ESD)
sensitive devices. Electrostatic charges readily accumulate on the
human body and any equipment, which can cause a discharge without
detection. Permanent damage may occur on devices subjected to
high-energy discharges. Proper ESD precautions are recommended
to avoid performance degradation or loss of functionality. Store unused
CY8CKIT-042-BLE boards in the protective shipping package.
End-of-Life/Product Recycling
The end-of-life cycle for this kit is five years from the date of
manufacture mentioned on the back of the box. Contact your nearest
recycler to discard the kit.
The CY8CKIT-042-BLE Bluetooth Low Energy (BLE) Pioneer Kit is intended for use as a
development platform for hardware or software in a laboratory environment. The board is an open
system design, which does not include a shielded enclosure. Due to this reason, the board may
cause interference with other electrical or electronic devices in close proximity. In a domestic
environment, this product ma y cause radio interfe rence. In such cases, the user may be required to
take adequate preventive measures. Also, this board should not be used near any medical
equipment or critical RF devices.
The CY8CKIT-042-BLE Bluetooth Low Energy (BLE) Pioneer Kit is intended for use as a
development, demonstration and evaluation platform for hardware or software in a laboratory
environment. The kit is not intended for general consumer use. Cypress recommends that the kit
only be used in a shielded room.
Attaching additional wiring to this product or modifying the product ope ration from the factory default
may affect its performance and cause interference with other apparatus in the immediate vicinity. If
such interference is detected, suitable mitigating measures should be taken.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 6
General Safety Instructions
ESD Protection
ESD can damage boards and associated components. Cypress recommends that the user perform
procedures only at an ESD workstation. If an ESD workstation is not available, use appropriate ESD
protection by wearing an antistatic wrist stra p attached to the chassis ground (any unpainted metal
surface) on the board when handling parts.
Handling Boards
CY8CKIT-042-BLE boards are sensitive to ESD. Hold the board only by its edges. After removing
the board from its box, place it on a grounded, static-free surface. Use a conductive foam pad if
available. Do not slide the board over any surf ac e.
Battery Care and Use
■ Use the correct size and type of battery specified in this guide.
■ Keep battery contact surfaces and battery compartment contacts clean by rubbing them with a
clean pencil eraser or a rough cloth each time you replace batteries.
■ Remove the battery from a device when it is not expected to be in use for several months.
■ Make sure that you insert the battery into your device properly, with the + (plus) and – (minus)
terminals aligned correctly.
■ Do not place the battery next to metallic objects such as keys and coins.
■ Never throw the battery into fire.
■ Do not open up the battery.
■ Do not short the battery.
■ Do not subject the battery to high temperatures or high humidity.
■ Store the battery in a dry place.
■ Do not recharge a battery unless it is marked “rechargeable.”
Battery Disposal
Batteries can be safely disposed of with normal household waste. Never dispose of batteries in fire
because they can explode. It is important not to dispose of large amounts of batteries in a group.
Used batteries are often not completely “dead.” Grouping used batteries together can bring these
“live” batteries into contact with one another, creating safety risks.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 7
Regulatory Compliance Information
CAUTION: Any changes or modifications not expressly approved by
the party responsible for compliance coul d void the user ’s authority to
operate the equipment.
Only the PCB antenna(s) that were certified with the module may be
used. Other antennas may be used only if they are of the same type
and have the same or lower gain.
The module must be recertified as a Class II permissive change if the
module is built into a different device than the EVB (evaluation board)
it was certified with
THE MANUFACTURER IS NOT RESPONSIBLE FOR ANY RADIO
OR TV INTERFERENCE CAUSED BY UNAUTHORIZED
MODIFICATIONS TO THIS EQUIPMENT. SUCH MODIFICATIONS
COULD VOID THE USER'S AUTHORITY TO OPERATE THE
EQUIPMENT.
The kit contains devices that transmit and receive radio signals in accordance with the spectrum
regulations for the 2.4-GHz unlicensed frequency range.
Cypress Semiconductor Corporation has obtained regulatory approvals for this kit to be used in
specific countries. These countries include United States (FCC Part 15), Canada (IC RSS210) and
Japan (JRF/ TELEC). Additional regional regulatory agency approval may be required to operate
these throughout the world.
This kit as shipped from the factory has been tested and found to comply with the limits/
requirements for following compliances:
■ FCC as a class B digital device, pursuant to part 15 of the FCC Rules.
■ This Class B digital apparatus complies with Canadian ICES-003
Regulatory statements and Product Labeling
United States (FCC)
This equipment complies with Part 15 of the FCC Rules. Operation is subject to the following two
conditions: (1) this device may not cause harmful inter ference, and (2) this d evice must accept any
interference received, including interference that may cause undesired operation.
The CY8CKIT-142 PSoC 4 BLE and CY5671 PRoC BLE modular transmitter must be labeled with
its own FCC ID number, and, if the FCC ID is not visible when the module is ins talled in to another
device, then the outside of the device into which the module is installed must also display a label
referring to the enclosed module. This exterior label can use wording such as the following:
Contains FCC ID: WAP-CY8CKIT-142 and WAP-CY5671, The enclosed device complies with Part
15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not
cause harmful interference and (2) this device must accept any interference received, including
interference that may cause undesired operation. Any similar wording that expresses the same
meaning may be used.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 8
CAUTION: The changes or modifications not expressly approved by the party responsible for
Compliance could void the user’s authority to operate the equipment and must not be co-located
or operating in conjunction with any other antenna or transmitter.
Canada (IC)
This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to
the following two conditions: (1) this device may not cause interference, and (2) this device must
accept any interference, including interference that may cause undesired operation of the device.
This equipment complies with radio frequency expos
uncontrolled environment.
CAUTION: Any changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment.
This Module is labelled with its own IC ID. If the IC ID Certification Number is not visible while
installed inside another device, then the device should display the label on it referring the enclosed
module. In that case, the final end product must be labelled in a visible area with the following:
“Contains Transmitter Module IC 7922A-CY8CKIT142 and 7922A-CY5671”
OR
“Contains IC: 7922A-CY8CKIT142 and 7922A-CY5671”
Le présent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio
exempts de licence. L'exploitation est autorisée aux deux conditions suivantes: (1) l'appareil ne doit
pas produire de brouillage, et (2) l'utilisateur de l'appareil doit accepter tout brouillage radioélectrique
subi, même si le brouillage est susceptible d'en compromettre le fonctionnement.
Cet équipement est conforme aux limites
Canada pour un environnement non contrôlé.
Ce module est étiqueté avec son propre ID IC. Si le numéro de certification IC ID n'est pas visible
lorsqu'il est installé à l'intérieur d'un autre appareil, l'appareil doit afficher l'étiquette sur le module de
référence ci-joint. Dans ce cas, le produit fi nal doit être étiqueté dans un endroit visible par le texte
suivant:
d'exposition aux radiofréquences définies par Industrie
ure limits set forth by Industry Canada for an
“Contains Transmitter Module IC 7922A-CY8CKIT142 and 7922A-CY5671”
OR
“Contains IC: 7922A-CY8CKIT142 and 7922A-CY5671”
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 9
Japan (TELEC)
Model:CY5671
FCC ID: WAP-CY5671
IC: 7922A-CY5671
TELEC: 005-100920
Model:CY8CKIY-142
FCC ID : WAP-CY8CKIT-142
IC : 7922A-CY8CKIT142
TELEC : 005-100919
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 10
1. Introduction
Thank you for your interest in the CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit. This
kit is designed to showcase the functionality and ease-of-use of the PSoC® 4 BLE and PRoC™ BLE
devices while developing Bluetooth Low Energy (Bluetooth Smart) app lications. Cypress's BLE solution has an easy-to-use, intuitive GUI to configure the BLE protocol stack using the BLE component
available in the Cypress standard integrated development environment (IDE), PSoC Creator. The
CySmart PC tool allows emulation of a BLE Central device and quick access to peripher al connections and debugging. The solution is a true single-chip solution with an integrated balun, Cypress's
industry-leading capacitive sensing technology, an analog front end (AFE) for biometric sensors, and
digital peripherals suited to a wide variety of applications. Designed for flexibility, this kit offers footprint compatibility with several third-party Arduino™ shields. The kit includes a provision to populate
an extra header to support Digilent
CapSense® slider, an RGB LED, a push-button switch, an integrated USB programmer, a program
and debug header, an F-RAM™, and USB-UART/I2C bridges.
1.1 Kit Contents
®
Pmod™ peripheral modules. In addition, the board features a
The BLE Pioneer Kit contains the following items, as shown in Figure 1-1.
■ BLE Pioneer Baseboard preloaded with the CY8CKIT-142 PSoC 4 BLE Module
■ CY5671 PRoC BLE Module
■ CY5670 CySmart USB Dongle
■ Quick start guide
■ USB standard A to mini-B cable
■ Four jumper wires (4 inch) and two proximity sensor wires (5 inch)
■ Coin cell
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 11
Figure 1-1. Kit Contents
Introduction
If any part of the kit is missing, contact your nearest Cypress sales of fice for help: www.cypress.com/
go/support.
1.2 Board Details
The BLE Pioneer baseboard consists of the blocks shown in Figure 1-2.
1. RGB LED
2. BLE module reset button
3. CapSense proximity header
4. User button
5. CapSense slider
6. Arduino compatible I/O header (J2)
7. Arduino compatible power header (J1)
8. Digilent Pmod compatible I/O header (J5)
9. Cypress F-RAM 1 Mb (FM24V10-G)
10.PSoC 5LP - programmer and debugger (CY8C5868LTI-LP039)
11.PSoC 5LP I/O header (J8)
12.Coin cell holder (bottom side)
13.USB conn ec to r (J1 3)
14.Power LED
15.Status LED
16.System power supply jumper (J16) - LDO 1.9 V~5 V
17.Arduino compatible I/O header (J3/J4)
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 12
18.BLE power supply jumper (J15) - for current measurement
19.BLE module headers (J10/J11)
Figure 1-2. BLE Pioneer Baseboard
Introduction
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 13
Introduction
(/%7%%"
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
7%%3(/%
1@1@
1@1@
1@1@
1@73&'
1@1@
1@1@
1@1@
93&41@
(/%1@
7%%%1@
7%%
(/%
1@
8JHHMF
BOUFOOB
,)[
DSZTUBM
CPUUPNTJEF
$NPE
$UBOL
"OUFOOB
NBUDIJOH
OFUXPSL"./
$:$-2*#-
14P$#-&EFWJDF
14P$
#-&NPEVMF
IFBEFS+
14P$
#-&NPEVMF
IFBEFS+
QJO6"35
IFBEFS
4"3CZQBTT
DBQBDJUPS
CPUUPNTJEF
(/%7%%"
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
1@1@
7%%3(/%
1@1@
1@1@
1@1@
1@73&'
1@1@
1@1@
1@1@
93&41@
(/%1@
7%%%1@
7%%
(/%
8JHHMF
BOUFOOB
$NPE
$UBOL
"OUFOOB
NBUDIJOH
OFUXPSL"./
.)[
DSZTUBM
$:#--29*
13P$#-&EFWJDF
13P$
#-&NPEVMF
IFBEFS+
13P$
#-&NPEVMF
IFBEFS+
QJO6"35
IFBEFS
4"3CZQBTT
DBQBDJUPS
CPUUPNTJEF
1@
1@
1@
.)[
DSZTUBM
,)[
DSZTUBM
CPUUPNTJEF
Figure 1-3 shows a markup of the onboard components, where red BLE module denotes the PSoC 4
BLE module and black BLE module denotes the PRoC BLE module.
Figure 1-3. BLE Module Markup
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 14
The dongle board consists of the blocks shown in Figure 1-4.
13P$#-&
SFTFUCVUUPO
$:#--29*
13P$#-&EFWJDF
14P$-1
QSPHSBNNJOHUFTUQPJOUT
$:$-5*-1
14P$-1QSPHSBNNFS
BOEEFCVHHFS
6TFSCVUUPO
1PXFS-&%
64#QMVH
4UBUVT-&%
8JHHMF
BOUFOOB
"OUFOOB
NBUDIJOH
OFUXPSL
"./
.)[DSZTUBM
6TFS-&%
13P$FYUFSOBMQSPHSBNNJOHIFBEFS
,)[
DSZTUBM
CPUUPNTJEF
48%*0
48%$-,
93&4
(/%
7#64
1@
1@
Figure 1-4. BLE Dongle Markup
Introduction
1.3 PSoC Creator™
PSoC Creator is a state-of-the-art, easy-to-use integrated design environment (IDE). It is a
revolutionary hardware and software co-design environment, powered by a library of preverified and
precharacterized PSoC Components™.
With PSoC Creator, you can:
■ Drag and drop PSoC Components to build a schematic of your custom design
■ Automatically place and route components and configure GPIOs
■ Develop and debug firmware using the included component APIs
PSoC Creator also enables you to tap into an entire tool e cosystem wit h integrate d compiler ch ains
and production programmers for PSoC devices.
For more information, visit www.cypress.com/psoccreator.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 15
1.4 Getting Started
This guide will help you get acquainted with the BLE Pioneer Kit:
■ The Software Installation chapter on page 20 describes the installation of the kit software. This
includes the PSoC Creator IDE for development and debu gging applications, PSoC Programmer
for programming hex files, and the CySmart PC tool for BLE host emulation.
■ The Kit Operation chapter on page 24 describes the major features of the BLE Pioneer Kit such
as USB-UART and USB-I2C bridges and functionalities such as programming and debugging.
■ The Example Projects chapter on page 42 describes multiple PSoC 4 BLE and PRoC BLE code
examples that will help you understand how to create your own BLE application using the BLE
component and device.
■ The Hardware chapter on page 88 details the hardware content of the kit and dongle, and the
hardware operation.
■ The Advanced Topics chapter on page 115 explains the functionality of the kit features, such as
the USB-UART bridge, USB-I2C bridge, F-RAM, iOS app, and the CySmart PC tool.
■ The Appendix on page 168 provides schematics, board layouts, KitProg LED status, and the bill
of materials (BOM).
1.5 Additional Learning Resources
Introduction
Visit www.cypress.com/go/psoc4ble and www.cypress.com/procble for additional learning resources
including datasheets, technical reference manuals, and application notes.
Visit www.cypress.com/go/cysmart for information on the CySmart PC tool.
1.5.1 Beginner Resources
PSoC Creator Traini ng: www.cypress.com/go/creatorstart/creatortraining
1.5.2 Application Notes
Visit www.cypress.com/appnotes to view a growing list of application notes for PSoC 3, PSoC 4,
PSoC 4 BLE, PRoC BLE, and PSoC 5LP.
Visit this site for PSoC 4BLE and PRoC BLE application notes.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 16
1.5.3 PSoC Creator Example Projects
These simple example projects demonstrate how to configure and use PSoC Creator co mponents.
To open an example proje ct in PSoC Creator, go to File > Example Project (see Figure 1-5) and
choose the required example project.
Figure 1-5. PSoC Creator Example Projects
Introduction
1.5.4 Component Datasheets
Right-click a component and select Open Datasheet (see Figure 1-6). Visit this page for the BLE
component datasheet.
Figure 1-6. Opening Component Datasheet
1.5.5 Bluetooth Learning Resources
The Bluetooth Developer Portal provides material by the Special Interest Group (SIG) for learning
various aspects of the Bluetooth Low Energy protocol and systems. Some of them are:
■ Training videos
■ GATT profiles
■ Bluetooth community forum
1.5.6 Learning From Peers
Cypress Developer Community Forums: Visit www.cypress.com/forums
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 17
1.5.7 Other Related Resources
■ Digilent PMod: www.digilentinc.com/pmods/
■ Arduino: http://arduino.cc/en/Main/ArduinoBoardUno
1.6 Technical Support
For assistance, go to our support web page, www.cypress.com/support, or contact our customer
support at +1 (800) 541-4736 Ext. 2 (in the USA) or +1 (408) 943-2600 Ext. 2 (International).
1.7 Documentation Conventi ons
Table 1-1. Document Conventions for Guides
Convention Usage
Courier New
Italics
[Bracketed, Bold]
File > Open
Bold
Times New Roman
Text in gray boxes Describes cautions or unique functionality of the product.
Displays file locations, user entered text, and source code:
C:\...cd\icc\
Displays file names and reference documentation:
Read about the sourcefile.hex file in the PSoC Creator User Guide.
Displays keyboard commands in procedures:
[Enter] or [Ctrl] [C]
Represents menu paths:
File > Open > New Project
Displays commands, menu paths, and icon names in procedures:
Click the File icon and then click Open.
Displays an equation:
2 + 2 = 4
Introduction
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 18
1.8 Acronyms
Table 1-2. Acronyms Used in this Document
Acronym Definition
ADC Analog-to-Digital Converter
API Application Programming Interface
BD address Bluetooth Device address
BLE Bluetooth Low Energy
CD Compact Disc
CDC Communications Device Class
COM Communication Port
DVD Digital Video Disc
ESD Electrostatic Discharge
F-RAM Ferroelectric Random Access Memory
GUI Graphical User Interface
GPIO General Purpose Input/Output
I2C Inter-Integrated Circuit
IAS Immediate Alert Service
IDAC Interconnecting Digital-Analog Converter
IDE Integrated Development Environment
ISO International Organization for Standardization
LDO Low Drop Out (voltage regulator)
LED Light-Emitting Diode
LP Low Power
LPT Line Print Terminal
PrISM Precise Illumination Signal Modulation
PRoC Programmable Radio-on-Chip
PRM Protocol Service Multiplexer
PSoC Programmable Systems-on-Chip
PWM Pulse-Width Modulation
QFN Quad Flat No-lead (package)
RGB Red Green Blue
SAR Successi ve Approximation Register
SPI Serial Peripheral Interface
SWD Serial Wire Debug
UART Universal Asynchronous Receiver Transmitter
USB Universal Serial Bus
USB CDC Universal Serial Bus Communications Device Class
Introduction
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 19
2. Software Installation
This chapter describes the steps to install the software tools and packages on a PC for using the
BLE Pioneer Kit. This includes the IDE in which the projects will be built and used for programming
the kit.
2.1 Before You Begin
All Cypress software installations require administrator privileges. Ensure you have the required
privileges on the system for successful installation. Before you install the kit software, close any
other Cypress software that is currently running.
2.2 Install Software
Follow these steps to install the BLE Pioneer Kit software:
1. Download the BLE Pioneer Kit software from www.cypress.com/CY8CKIT-042-BLE. The kit
software is available in the following formats:
a. CY8CKIT-042-BLE Kit Setup: This installation package contains the files related to the kit.
However, it does not include the Windows Installer or Microsoft .NET framework packages. If
these packages are not on your computer, the installer directs you to download and install
them from the Internet.
b. CY8CKIT-042-BLE Kit Only: This executable file installs only the kit contents, which include kit
code examples, hardware files, and user documents. This package can be used if all the
software prerequisites (listed in step 5) are installed on your PC.
c. CY8CKIT-042-BLE DVD ISO: This file is a complete package, stored in a DVD-ROM image
format, that you can use to create a DVD or extract using an ISO extraction program such as
WinZip or WinRAR. The file can also be mounted similar to a virtual CD/DVD using virtual
drive programs such as ‘Virtual CloneDrive’ and ‘MagicISO’. This file includes all the required
software, utilities, drivers, hardware files, and user documents.
2. If you have downloaded the ISO file, mount it on a virtual drive; if you do not have a virtual drive
to mount, extract the ISO contents using the appropriate ISO extractor (such as MagicISO or
PowerISO). Double-click cyautorun.exe in the root directory of the extracted content or mounted
ISO if “Autorun from CD/DVD” is not enabled on the PC. The installation window will appear
automatically.
Note: If you are using the “Kit Setup” or “Kit Only” file, then go to step 4 for installation.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 20
Software Installation
3. Click Install CY8CKIT-042-BLE Kit to start the kit installation, as shown in Figure 2-1.
Figure 2-1. Kit Installer Screen
4. Select the folder in which you want to install the CY8CKIT-042-BLE kit-related files. Choose the
directory and click Next.
5. When you click Next, the CY8CKIT-042-BLE Kit installer automatically installs the required
software, if it is not present on your computer. The following software packages are required:
Note: For the Setup Only installer package, download and install the following prerequisites.
a. PSoC Creator 3.1 or later: Download the latest version from www.cypress.com/psoccreator.
b. PSoC Programmer 3.21.1 or later: This is installed as part of PSoC Creator installation
(www.cypress.com/programmer).
c. CySmart 1.0 or later: Download the latest version from www.cypress.com/go/cysmart.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 21
Software Installation
6. Choose the Typical/Custom/Complete installation type in the Product Installation Overview
window, as shown in Figure 2-2. Click Next after you select the installation type.
Figure 2-2. Product Installation Overview
7. Read the license agreement and select I accept the terms in the license agreement to
continue with installation. Click Next.
8. When the installation begins, a list of packages appears on the installation page. A green check
mark appears next to each package after successful installation.
9. Click Finish to complete the CY8CKIT-042-BLE kit installation.
10.Enter your contact information or select the Continue Without Contact Information check box.
Click Finish to complete the CY8CKIT-042-BLE kit installation.
11.After the installation is complete, the kit contents are available at the following location:
<Install_Directory>\CY8CKIT-042-BLE Kit
Default location:
Windows 7 (64-bit): C:\Program Files (x86)\Cypress\CY8CKIT-042-BLE Kit
Windows 7 (32-bit): C:\Program Files\Cypress\CY8CKIT-042-BLE Kit
Note: For Windows 7/8/8.1 users, the installed files and the folder are read only. To use the installer
example project, follow the steps outlined in the Example Projects chapter on page 42.
The kit installer also installs the CySmart PC tool for PC. This software, along with the dongle , allows
the PC to emulate as a BLE Central de vice . R ef er to CySmart PC Tool on page 160 for more details
on how to use the CySmart PC tool.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 22
2.3 Uninstall Software
The software can be uninstalled using one of the following methods:
■ Go to Start > All Programs > Cypress > Cypress Update Manager > Cypress Update
Manager; select the Uninstall button.
■ Go to Start > Control Panel > Programs and Features for Windows 7 or Add/Remove
Programs for Windows XP; select the Uninstall/Change button.
Software Installation
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 23
3. Kit Operation
Status LED
Green
BLE/Arduino Compatible Headers
Proximity wire
connector
CapSense Slider
5 Segment
Reset SW
(Push Button)
USB
Mini B
PSoC 5LP
Programmer/Serial
Communication
PSoC 5LP
10 pin Prog. header
PSoC 5LP I/Os
16 pin Expansion header
PMOD header
6 pin PMOD header
ESD
Protection
MOSFET
Protection ckt
LDO
ORing
Diodes
BLE/Arduino Compatible Headers
Jumper
BLE current measuring
Coin cell
Battery holder
Power
LED Red
BLE Module I/Os
20 pin header
FRAM
I2C pull-up
via FET
ORing
Diodes
User SW
(Push Button)
BLE Module I/Os
24 pin header
VIN
VBUS
VCC
D+ / D-
VDD
BLE Reset
3.3V
~3V
SWD
I2C / SPI / UART
I2C
Voltage Ctrl
3 pin Jumper
RGB LED
MOSFET
Protection ckt
BLE SWD
10 pin Prog. header
PRoC BLE/
PSoC 4 BLE
This chapter introduces you to the BLE Pioneer kit and the features that will be used as part of the kit
operation. We will discuss features such as USB connection, programming/debugging, and
programmer firmware update. The chapter also describes the USB-UART and USB-I2C bridges
along with the PC tools that can be used to communicate with the BLE device on the kit.
3.1 Theory of Operation
Figure 3-1, Figure 3-2, and Figure 3-3 show the block diagrams for the BLE Pioneer baseboard, BLE
module board, and BLE dongle.
Figure 3-1. BLE Pioneer Baseboard Block Diagram
The BLE Pioneer board acts as the baseboard for the PSoC 4 BLE (red module) and PRoC BLE
(black module). The Pioneer board contains a PSoC 5LP that is used as an onboard programmer or
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 24
debugger, and for the USB-Serial interface.
The baseboard is Arduino form-factor compatible, enabling Arduino shields to be connected on top
of the board to extend the functionality of BLE modules. The board also features a 1-Mb F-RAM, an
RGB LED, a five-segment CapSense slider, a proximity header, a user switch, and a reset switch for
the PSoC 4 BLE and PRoC BLE devices on the module. The Pioneer board supports three voltage
levels: 1.9 V, 3.3 V, and 5 V.
The baseboard can also be used as a standalone programmer to program and debug other PSoC 4
BLE/PRoC BLE devices using serial wire debug (SWD), and as a USB-Serial bridge. The firmware
on PSoC 5LP device enables bootloading PSoC 5LP over USB to upgrade the firmware.
Kit Operation
PRoC BLE/
PSoC 4
BLE
BLE I/Os
20 pin Header (Digital, Power and Ground Pins)
GPIO
GPIO
KHz
Crystal
Decaps
CMOD
SAR
Bypass Cap
CTANK
VREF
Power
RF
matching
MHz
Crystal
Test
points
4 pin
header
RX/ TX/ Gnd
BLE I/Os
24 pin Header (Analog, Power and Ground Pins)
Ferrite Bead
VDDD/A/R
Power
Power
Decaps
MATCHING
CIRCUIT
PSoC 5LP
68QFN
I2C
UART
SWD
SPI
USB
2.0
Type-A
Plug
10-Pin Programming
Header
SWD
USER Button
USER LED
XRES Button
XRES
RF
Test Points
Protection
Circuits
D+ / D-
STATUS LED
POWER LED
EXTRA GPIO
CRYSTALS
PRoC BLE
56QFN
Power
Figure 3-2. BLE Module Block Diagram
This kit includes two modules boards. These boards act as a basic breakout board for the
CY8C4247LQI-BL483 and CYBL10563-56LQXI BLE silicon. The PSoC 4 BLE and PRoC BLE
Modules are identical except for the silicon. In addition to including the PSoC 4 BLE and PRoC BLE
devices, the module boards also contain the BLE passives (resistors, capacitors, external crystals,
and antenna-matching network), an onboard antenna, and headers for connectin g to th e baseb oard.
The BLE dongle is the host's wireless interface for the BLE device or project on the baseboard. The
dongle has a PRoC BLE device, to allow BLE connection with other kits. It also contains a
PSoC 5 LP, to be used as an onboard programmer or debugger, and for the USB-Serial interface, as
shown in Figure 3-3.
The dongle has a USB A-type plug to connect the PSoC 5LP to the USB port of the host PC. The
PSoC 5LP then communicates with the PRoC BLE device over UART or multiplexed I
bus. The board also features a user LED, a user switch, and a reset switch for the PRoC BLE
device. The dongle is powered directly through the USB port (VBUS) at 5.0 V.
The BLE dongle can also be used as a standalone programmer to program and debug other PSoC
devices (outside the dongle board) using SWD, and as a USB-Serial bridge after removing the
resistor between the SWD pins of PSoC 5LP and PRoC BLE.
Figure 3-3. BLE Dongle Block Diagram
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 25
2
C or an SPI
3.2 BLE Pioneer Kit USB Connection
The BLE Pioneer kit connects to and powers from a PC over the USB interface (J13). The kit enumerates as a composite device, as shown in Table 3-1.
Note: Ensure that you install the kit installer on the system for successful enumeration. To download
and install the BLE Pioneer Kit, visit www.cypress.com/go/CY8CKIT-042-BLE.
Table 3-1. BLE Pioneer Kit Enumerated Interfaces
Port Description
USB Composite Device Composite device
USB Input Device Programmer and debugger
KitProg
KitProg USB-UART USB-UART bridge, which appears as a COM# port
Figure 3-4. KitProg Driver Installation (appearance may differ depending on Windows platform)
USB-I2C bridge, programmer
Kit Operation
3.3 Placing Modules on Baseboard
Plug the BLE module into the baseboard on headers J10 and J11, while keeping the antenna
directed outside of the baseboard. Note that the two parallel headers J10 and J11 are not equal
(24-pin and 20-pin, respectively) and will not allow the BLE module to be inserted in the opposite
direction.
Figure 3-5. Baseboard with J10 and J11 Headers to Connect BLE Modules
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 26
Kit Operation
To remove the BLE modules from the BLE Pioneer kit, hold the BLE Pioneer kit in one hand and the
BLE module in the other, as shown in Figure 3-6, and pull it out using a rocking motion.
Figure 3-6. Remove BLE Module Connected on BLE Pioneer Kit
3.4 Programming and Debugging BLE Device
The BLE Pioneer kit and BLE dongle can be programmed and debugged using the onboard
PSoC 5LP programmer and debugger. Before programming the device, ensure that PSoC Creator
and PSoC Programmer are installed on the PC. See the section Install Software on page 20 for
more information.
3.4.1 Programming and Debugging using PSoC Creator
1. To program the BLE Pioneer kit, plug the USB cable into the programming USB connector, J13,
and connect it to the USB port on the PC, as shown in Figure 3-7. The kit will enumerate as a
composite device.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 27
Kit Operation
Mini USB PSoC 5LP
PSoC 4 BLE/
PRoC BLE
SWDCLK
Reset
SWDIO
D+
D-
Figure 3-7. Connect USB Cable to J13
2. To program the BLE dongle, plug the dongle into the USB port of the PC, as shown in Figure 3-8.
The dongle will enumerate as a composite device.
Figure 3-8. Connect BLE Dongle to PC
3. The onboard PSoC 5LP uses SWD to program the PSoC 4 BLE or PRoC BLE device. See
Figure 3-9 for this implementation.
Figure 3-9. SWD Programming PSoC 4 BLE/PRoC BLE using PSoC 5LP
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 28
Kit Operation
4. To load the desired example project, open PSoC Creator and go to File > Open > Project/
Workspace. This will provide the option to browse to and open your saved project.
5. Build the project by choosing Build > Build <Project Name> or [Shift] [F6], as shown in
Figure 3-10.
Figure 3-10. Build an Example Project
6. If there are no errors during build, program the firmware into the kit by choosing Debug >
Program or pressing [Ctrl] [F5], as shown in Figure 3-11. This will program the device on the
BLE Pioneer Kit/BLE dongle and it will be ready for use. If debugging is needed on the project, go
to step 6.
Figure 3-11. Programming Device From PSoC Creator
7. To debug the project using PSoC Creator, choose
Debug > Debug or press [F5].
8. When the project is built and programmed into the device on the BLE Pioneer kit/BLE dongle,
PSoC Creator will enter the Debug mode; you can use it to debug your application. For more
details on using the debug features, see the Cypress application note Getting Started with PSoC
4 BLE.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 29
3.4.2 Programming using PSoC Programmer
PSoC Programmer (3.21 or later) can be used to program existing hex files into the BLE Pioneer kit
or BLE dongle. To do this, follow these steps.
1. To program the BLE Pioneer kit, plug the USB cable into the programming USB connector, J13,
and connect it to the PC USB port, as shown in Figure 3-7. The kit will enumerate as a composite
device.
Figure 3-12. Connect BLE Pioneer Kit to PC
Kit Operation
2. To program the BLE dongle, plug the dongle to the USB port of the PC, as shown in Figure 3-13.
The kit will enumerate as a composite device.
Figure 3-13. Connect BLE Dongle to PC
3. Go to
Start > All Programs > Cypress > PSoC Programmer <version> > PSoC Programmer
<version>. The PSoC Programmer window will open as shown in Figure 3-13.
Note: BLE projects support PSoC Programmer 3.21 or later.
CY8CKIT-042-BLE Bluetooth® Low Energy (BLE) Pioneer Kit Guide, Doc. # 001-93731 Rev. *A 30
Loading...