Cypress Semiconductor CY8CKIT-022 User Manual
CY8CKIT-022
CapSense® Liquid Level Sensing Shield
Kit Guide
Doc. #: 002-09825 Rev. **
Cypress Semiconductor
198 Champion Court
San Jose, CA 95134-1709
Phone (USA): +1.800.858.1810
Phone (Intnl): +1.408.943.2600
www.cypress.com
Copyrights
Copyrights
© Cypress Semiconductor Corporation, 2015. 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.
PSoC and CapSense are registered trademarks and PSoC Creator, F-RAM, EZ-BLE, and PRoC are trademarks of Cypress
Semiconductor Corp. All other trademarks or registered trademarks referenced herein are property of the respective
corporations.
Flash Code Protection
Cypress products meet the specifications contained in their particular Cypress PSoC Data Sheets. Cypress believes that its
family of PSoC 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 protec tion 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 p rotecti on is constantly
evolving. We at Cypress are committed to continuously improving the code protection features of our products.
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 2
Contents
1. Introduction
1.1 Kit Contents..................................... ... ... ....................................... ... ... ... .... ... ... ............7
1.2 Getting Started.............................................................................................................8
1.3 Additional Resources................ ... .... ... .........................................................................9
1.4 Hardware Requirements..............................................................................................9
1.5 Software Requirements ................................ ... ... ... ... .... ... ... ... .... ... ... ..........................10
1.6 Application Notes and Projects..................................................................................10
1.7 Technical Support......................................................................................................10
1.8 Documentation Conventions .....................................................................................11
1.9 Acronyms...................................................................................................................11
2. Kit Hardware 12
2.1 Board Details ................................... ... ... ... .... ... ..........................................................12
2.2 Kit Assembly................................................................. ... ... ... .... ... ... ... ... .... ................15
2.3 Theory of Operation..................... .... ... ... ... .... ... ... ... ... .... ... ... ... ....................................17
2.4 Functional Description .................................. ......................................... .... ... ... ... .......19
1.5.1 PSoC Creator.................................................................................................10
1.5.2 PSoC Programmer.........................................................................................10
2.3.1 Principle of Capacitive Liquid Level Sensing .................................................17
2.3.2 CY8CKIT-022 Kit............................................................................................18
2.4.1 Two Sensor Flexible PCB.............................................. ... ... ... ... .... ... ... ... .......19
2.4.2 12 Sensor Flexible PCB.................................................................................19
2.4.3 Flexible Sensor Connector.............................................................................20
2.4.4 Arduino-Compatible Headers........................ .... ... ... .......................................20
2.4.5 Temperature Compensation Sensor ..............................................................22
2.4.6 Integration Capacitors....................................................................................22
2.4.7 UART Connection...................................... ... .... ... ... ... .... ... ... ..........................23
2.4.8 Liquid Container......................................................................... .... ... ... ... .... ...23
3. Example Projects 24
4. Design Support 25
A. Appendix 26
A.1 Shield Schematic.......................................................................................................26
A.2 2RX Sensor Schematic..............................................................................................27
A.3 12RX Sensor Schematic............................................................................................28
A.4 Shield Layout.............................................................................................................29
A.5 2RX Sensor Layout....................................................................................................30
A.6 12RX Sensor Layout..................................................................................................31
A.7 Bill of Materials ..........................................................................................................32
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 3
Contents
Revision History 33
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 4
Safety Information
The Liquid Level Sensing Shield Kit contains ESD-sensitive
devices. Electrostatic charges readily accumulate on the
human body and any equipment, and can 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 kit boards
in the protective shipping package.
End-of-Life/Product Recycling
This kit has an end-of life five years from the date of
manufacture mentioned on the back of the box. Cont act your
nearest recycler for discarding the kit.
Regulatory Compliance
The CapSense Liquid Level Sensing Shield Kit (CY8CKIT-022) 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. This may cause interference to other electrical or
electronic devices in close proximity. In a domestic environment, this product may cause radio
interference. In such cases, you may be required to take adequate preventive mea sures. In addition,
this board should not be used near any medical equipment or RF devices.
Attaching additional wiring to this product or modifying the product ope ration from the factory default
may affect its performance and cause interf erence with other apparatus in the immediate vicinity. If
such interference is detected, suitable mitigating measures should be taken.
The Liquid Level Sensing Shield Kit, as shipped from the factory, has been verified to meet with the
requirements of CE as a Class A product.
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 5
General Safety Instructions
ESD Protection
ESD can damage boards and associated components. Cypress recommends that you perform
procedures only at an ESD workstation. If such a 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 your board when handling parts.
Handling Boards
CY8CKIT-022 boards are sensitive to ESD. Hold the board only by its edges. Do not slide the board
over any surface.
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 6
1. Introduction
Thank you for your interest in the CapSense® Liquid Level Sensing Shield Kit (CY8CKIT-022). This
kit is intended to demonstrate the Liquid Level Sensing (LLS) capabilities of the CapSense technology in Cypress’s PSoC
This kit supports the following liquid level sensing features:
■ Non-contact measurement of liquid levels from sensors located on the exterior of the non-
conductive liquid container . Av oids contamination and cleani ng issues found with mechanical and
contact sensors, simplifying industrial design and improving user experience.
■ Supports two different sensor patterns. A two sensor ‘Backgammon’ shaped pattern provides
liquid level sensing at a low cost point while a multi sensor ‘Segmented’ pattern provides
increased accuracy that can be optimized for each design by varying the number and shape of
sensors.
This kit guide provides details on the kit contents, hardware, schematics, and BOM. See Code
Example CE202479 for example projects developed for use with this kit and
AN202478 - PSoC 4 - Capacitive Liquid Level Sensing for theory, design guidance, and sensor
layout information.
®
4 products.
1.1 Kit Contents
The CapSense Liquid Level Sensing Shield Kit contains the following, as shown in Figure 1-1.
■ CapSense
■ CapSense Liquid Level Sensing 12 Sensor Flex PCB
■ CapSense Liquid Level Sensing 2 Sensor Flex PCB
■ Liquid container
■ Quick Start Guide
■ Micrium's C/Probe license card
®
Liquid Level Sensing Shield board
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 7
Figure 1-1. Kit Contents
Introduction
Inspect the contents of the kit; if you find any part missing, contact your nearest Cypress sales office
for help.
1.2 Getting Started
This guide will help you get acquainted with the CapSense Liquid Level Sensing Shield Kit:
■ The Kit Hardware chapter on page 12 describes how to assemble and use the kit’s resources.
■ The Example Projects chapter on page 24 provides the major features of the Liquid Level
Sensing Shield Kit.
■ The Design Support chapter on page 25 provides information on documents and resources
required to start new liquid level sensing desings with PSoC 4 CapSense.
■ The Appendix on page 26 provides detailed hardware description, schematics, and bill of
materials (BOM).
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 8
1.3 Additional Resources
Cypress provides a wealth of data at www.cypress.com to help you select the right PSoC device for
your design, and to help you to quickly and effectively integrate the device into your design. For a
comprehensive list of resources, visit http://www.cypress.com/psoc. The web page includes a list of
PSoC device families, integrated design environments (IDEs), and associated development kits. In
addition, refer to the following documents to get started with PSoC 4 devices and CapSense
technology:
■ AN79953 - Getting Started with PSoC® 4
■ Getting Started with CapSense®
■ PSoC® 4 CapSense® Design Guide
■ AN202478 - PSoC 4 - Capacitive Liquid Level Sensing
■ CE202479 - Code Example for Liquid Level Sensing
■ PSoC 101 Training Series
1.4 Hardware Requirements
CY8CKIT-022 plugs into any Arduino™ hardware-compatible development platform from Cypress.
CE202479 provides example projects targe ting the CY8CKIT-042 PSoC 4 Pioneer Kit.
Introduction
Figure 1-2 shows how the CY8CKIT-022 kit connects to the CY8CKIT-042 kit.
Visit http://www.cypress.com/CY8CKIT-042 to purchase the CY8CKIT-042 kit.
Figure 1-2. CY8CKIT-022 Connected to CY8CKIT-042
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 9
1.5 Software Requirements
The CY8CKIT-022 kit does not have any programmable/configurable devices onboard, so it does not
need any software for configuration. However, the PSoC device present on the CY8CKIT-042
baseboard requires firmware which you can develop with the PSoC Creator IDE (Version 3.3 CP1 or
later).
1.5.1 PSoC Creator
PSoC Creator allows concurrent hardware and application firmware design of PSoC 3, PSoC 4, and
PSoC 5LP systems. PSoC systems are designed using classic, familiar, schematic-capture technology supported by pre-verified, productio n- re a dy PSoC Com pon en ts™.
PSoC Components are analog and digital virtual chips represented by icons that you can drag and
drop into a design and configure to suit a broad array of application requireme nts. You can configure
each Component in the rich, mixed-signal Cypress Component Catalog with the Component Customizer tool. These Components include a full se t of dynamically generated API libraries. After you
have configured the PSoC system, you can write, compile, and debug the firmware within PSoC
Creator, or export the firmware to other IDEs such as those from IAR, Keil, and Eclipse.
You can download the latest version of the PSoC Creator software from http://www.cypress.com/
psoccreator. Refer to the Release Notes for the minimum and recommended system requirements.
Introduction
1.5.2 PSoC Programmer
The PSoC Programmer software is used to program the PSoC devices on the CY8CKIT-042 kit with
hex files. You can download PSoC Programmer at http://www.cypress.com/go/psocprogrammer.
1.6 Application Notes and Projects
■ AN202478 - PSoC 4 - Capacitive Liquid Level Sensing provides detailed theory, design
guidance, and sensor layout information for explaining this kit s oper ation as we ll as develop ing a
new liquid level sensing design.
■ CE202479 contains example projects that demonstrate the following features of the
CY8CKIT-022 kit:
❐ Liquid level measurement using capacitive sensors
❐ Two sensor (2RX) project for use with the low cost 2RX flexible sensor
❐ Twelve sensor (12RX) project for use with the increased accuracy 12RX flexible sensor
❐ See the 3. Example Projects chapter in this kit guide for details.
1.7 Technical Support
For assistance, visit Cypress Support or contact customer support at +1 (800) 541-4736 Ext. 2 (in
the USA) or +1 (408) 943-2600 Ext. 2 (International).
You can also use the following support resources if you need quick assistance:
■ Self-help (Technical Documents)
■ Local Sales Office Locations.
CY8CKIT-022 CapSense® Liquid Level Sensing Shield Kit Guide, Doc. #: 002-09825 Rev. ** 10
Loading...