User Guide. EZ-Click 2.0. Document # Rev *C

Transcription

1 EZ-Click 2.0 User Guide Document # Rev *C Cypress Semiconductor 198 Champion Court San Jose, CA Phone (USA): Phone (Intl):

2 Copyrights Cypress Semiconductor Corporation, The information contained herein is subject to change without notice. Cypress Semiconductor Corporation assumes no responsibility for the use of any circuitry other 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 safety applications, unless pursuant to an express written agreement with Cypress. Furthermore, 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 products in lifesupport 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 Cypress 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. 2 EZ-Click 2.0 User Guide, Document # Rev *C

3 Contents 1 Introduction Welcome Getting Started Help Topics Document History Basic EZ-Click Tasks Creating a new project Opening an existing project Select I2C Target Configuring a project Generating the configuration file Program the target device Reset Saving a project Printing the project Exiting the tool EZ-Click Framework Start Page CapSense Sensor Configuration Global Configuration Visual Configuration CapSense Output System Diagnostics Menus and Toolbar File Menu Configuration Menu Help Menu Toolbar Support Index EZ-Click 2.0 User Guide, Document # Rev *C 3

4 Contents This page intentionally left blank. 4 EZ-Click 2.0 User Guide, Document # Rev *C

5 1 Introduction 1.1 Welcome Use EZ-Click to take your products to market in the shortest possible time by providing simple graphical configuration options for Cypress devices. With EZ-Click you can quickly configure CapSense Express parts. No code development Less time prototyping Faster time to market 1.2 Getting Started To get started with your project, follow these steps: 1. Create a new project: Click New Project and use the Product Selector dialog to select the various project options. 2. Select Target Device: Click Select Target Device and use the Select dialog to choose the device connected to your PC. 3. Set up parameters: Use each of the configuration tabs to define functionality for the device and to test it. Use the Design Toolbox for guidance, as needed. 4. Generate Configuration File: Click Generate Config File to generate the configuration file for the device. 5. Program the Device: Click Apply Current Config to program the device with your settings. 1.3 Help Topics Use the following sections in this help to learn more about using EZ-Click: Basic EZ-Click Tasks EZ-Click Framework Start Page CapSense Sensor Configuration Global Configuration EZ-Click 2.0 User Guide, Document # Rev *C 5

6 Introduction Visual Configuration CapSense Output System Diagnostics Support 1.4 Document History Document Title: EZ-Click 2.0 User Guide Document Number: Revision Date Description of Change ** 1/23/14 New document. *A 2/20/14 Updates for GUI changes. *B 3/4/14 Updates for GUI changes. *C 6/3/14 Fixed a few typos, and clarified information for a few fields. 6 EZ-Click 2.0 User Guide, Document # Rev *C

7 2 Basic EZ-Click Tasks Creating a new project Opening an existing project Select I2C Target Generating the configuration file Program the target device Reset Saving a project Printing the project Exiting the tool EZ-Click 2.0 User Guide, Document # Rev *C 7

8 Basic EZ-Click Tasks 2.1 Creating a new project To create a new project, use the Product Selector dialog to specify various features and filter the devices that will accommodate your design To open the Device Selector: Select Device Selector on the New Project dialog. Open the New Project dialog from the File menu, or press [Ctrl] + [N] from the EZ-Click main window. You can also click the New Project link on the Start Page To use the Device Selector: 1. Under Device filters, select the number of sliders, buttons, LEDs, etc. to use in your design. As you select the different filters, the number of devices available on the right side of the dialog will decrease. 8 EZ-Click 2.0 User Guide, Document # Rev *C

9 Basic EZ-Click Tasks 2. When finished choosing filters, double-click on a device part number, or select it and click New EZ- Click Project. Note Depending on the device you select, the button will change to one of the following: New EZ-Click Project Creates a new EZ-Click project with the selected device. Go to product webpage Launches a web browser to the product page for the selected device. 2.2 Opening an existing project To open an existing EZ-Click project, use the Open Project dialog to find and select the project to open To open the dialog: Select Open Project... from the File menu or press [Ctrl] + [O] from the EZ-Click main window. You can also click the Browse link on the Start Page. Note You can also view and select existing projects from the File > Recent Projects menu item To use the dialog: Navigate and select the appropriate *.cprj file and click Open. EZ-Click 2.0 User Guide, Document # Rev *C 9

10 Basic EZ-Click Tasks 2.3 Select I2C Target Use the Select I 2 C Target dialog to select the appropriate Cypress device to use with your project. Depending on which kit or device you have connect to the computer, different Ports and Devices will be available to select. Current kits include: CY8CKIT-002, CY3280-MBR2, and CY3280-MBR To open the dialog: After creating a new project or opening an existing project, choose Select Target Device from the Configuration menu or from the toolbar To use the dialog: Select a Port and a Device. Then, select an option for Power and I 2 C Speed, and click OK. 2.4 Configuring a project Configuring a project involves various settings on the different EZ-Click tabs. Tabs will vary depending on the selected device: CapSense Sensor Configurations Global Configurations Visual Configurations CapSense Output System Diagnostics 10 EZ-Click 2.0 User Guide, Document # Rev *C

11 Basic EZ-Click Tasks 2.5 Generating the configuration file Select Configuration> Generate Config File to generate configuration files for the design. This creates three new files in the project directory. Each file contains the same information in a different format; any of which can be used to configure the device. *.iic - This I2C configuration file can be used with Bridge Control Panel to apply the settings to the target device. *.hex - This Intel compatible hex file can be used via an I2C programmer to update the configurable portion of the device memory. *.h - This C header file can be included in an embedded device which communicates via I2C to the target device. 2.6 Program the target device 2.7 Reset Select Configuration > Apply Current Config to program the device with the current config (*.iic) file. This feature is provided to reset the configuration of the selected tab or all tabs at one time. Select Configuration > Reset Tab to reset the parameters in the current tab to the default values. Select Configuration > Reset All Tabs to reset the parameters in all the tabs to default values. 2.8 Saving a project Select File > Save Project to save the current project. If you attempt to close a project without saving, the tool will prompt you to save. You can also make a copy of your project by selecting File > Save Project As Printing the project Select File > Print to print the current screen. Click File > Print Preview to preview the current screen prior to printing it Exiting the tool Select File > Exit or the close button in the top-right corner to close the tool. EZ-Click 2.0 User Guide, Document # Rev *C 11

12 Basic EZ-Click Tasks This page intentionally left blank. 12 EZ-Click 2.0 User Guide, Document # Rev *C

13 3 EZ-Click Framework The basic EZ-Click tool framework consists of various tabs to create and configure a project, as follows: Start Page CapSense Sensor Configuration Global Configuration Visual Configuration CapSense Output System Diagnostics EZ-Click 2.0 User Guide, Document # Rev *C 13

14 EZ-Click Framework 3.1 Start Page The EZ-Click Start page provides a quick overview of how to use the tool, as well as links to create new projects and open existing projects. 3.2 CapSense Sensor Configuration The CapSense sensor configuration tab provides all settings related to CapSense sensors. This includes buttons, sliders, and proximity sensors. Note Some devices do not support all sensor types. So, not all options on the tab will be available for all devices General Options Number of sliders Use this parameter to specify the number of sliders for your project when using an applicable device. If you specify one or more sliders, a Sliders section will display to set various options. See Slider Options. 14 EZ-Click 2.0 User Guide, Document # Rev *C

15 EZ-Click Framework Number of proximity sensors Use this parameter to specify the number of proximity sensors for your project when using an applicable device. If you specify one or more sensor, a Proximity Sensors section will display to set various options. See Proximity Sensor Options. IIR filter Use this parameter to enable or disable the Infinite impulse response (IIR) filter. Refer to the device datasheet for more information. Median filter Use this parameter to enable or disable the median filter. Refer to the device datasheet for more information. Automatic threshold Use this parameter to set various thresholds, such as finger threshold and noise thresholds dynamically, depending on the noise of the system. If this parameter is enabled, then the finger threshold parameter for buttons will remain disabled; however, the finger threshold parameter for sliders and sensors must always be set. See Finger Threshold. Advanced low-pass filter Use this parameter to enable or disable the advanced low-pass filter, as well as specify the IIR input weighting. This is used for proximity sensors. Refer to the device datasheet for more information. Scan period Use this parameter to set the scan period in ms. The scan period specifies the amount of time between successive sensor scans by the device. The scan period is dependent on the number of sensors used in the design. As sensors are enabled the scan period will automatically be decreased, if necessary, to ensure the sensors can all be scanned in the available time. Note that the tool will not automatically increase the scan period again if the number of sensors is decreased. This is because there is a trade off between accuracy of the sensors and the power consumption, which is left up to the user. When the device is powered up, the sensors are scanned quickly, that is, the scan period is low. This is the minimum scan period you can configure for specific applications. After some time, the device increases the scan period (for idle state, when the button is not touched) to reduce the power consumption. When the button is touched during the idle state, the scan period is again reduced for the next touch Slider Options The scanning process consumes high power and therefore, faster response comes at the cost of increased power consumption. According to the thumb rule, the scan period delay should be low for faster response and high for increased power consumption. For a larger number of buttons, the minimum scan period delay is high. Set the scan period by clicking the slider. Sensor Enter the name of the sensor. Segments Select the number of segments. Pins This is a read-only field that displays the pins. Type Select the slider type: linear or radial. EZ-Click 2.0 User Guide, Document # Rev *C 15

16 EZ-Click Framework Sensitivity Sensitivity is a measure of how much the output changes for a given input change. You can set the sensitivity for each slider, sensor, and button. This parameter helps you to set the minimum finger capacitance required to turn ON a button. Different sensors in the UI need different sensitivity. For example, the power button can be less sensitive than the other buttons in the UI. The default option is high. Finger Threshold Use this parameter to select the appropriate value for each slider, sensor, or button if automatic threshold is disabled. Based on the finger threshold parameter, all the other thresholds (noise threshold, negative noise threshold, and so on.) are calculated. The touch on the button is registered only if the sensor output is higher than the finger threshold. The CapSense algorithm converts the sensor capacitance into a digital count, called raw count. The raw count is interpreted as either a TOUCH or NO TOUCH state for the sensor. The numerical value of the raw count is the digital representation of the sensor capacitance, and increases while the capacitance increase. The baseline reference level is the average raw count level with no finger present. This reference level is continuously updated when a finger is not on the sensor. In idle condition (no touch), the output (raw count) has only the internal noise component. When the button is touched, the raw count rises. Thus, there is a difference count between these two raw counts. Now, 80 percent of the difference count should be set as the finger threshold for a proper identification of the touch. This is a decimal value between 50 and 245 for a button that is set to 50 as default for each button. The default value is 50. Resolution Select the appropriate resolution value Proximity Sensor Options Pin Select the pin to use for this sensor. Sensor Enter the sensor name. Resolution Controls the number of bits used to detect and track the proximity measurements. Proximity threshold Select the appropriate value. +ve Threshold Select the appropriate positive proximity threshold value. -ve Threshold Select the appropriate negative proximity threshold value. Sensitivity Select the appropriate value. Finger Threshold See Finger Threshold. 16 EZ-Click 2.0 User Guide, Document # Rev *C

17 EZ-Click Framework Wakeup Sensor For CY8CMBR3xxx devices, this option enables or disables the "Look-for- Proximity" state on the device. This state allows ultra-low power consumption when a human body is not in close proximity. Once proximity is detected, the controller will enter the "Look-for-Touch" state. For more information, refer to the device datasheet. Initial/Subsequent Response Time The response time is the minimum amount of time a sensor should be touched for the device to detect as valid sensor touch. The response time is calculated from the Debounce value. If a fast response is required for an output, the debounce time should be low Button Options Enable Select to enable the associated button. Pin Read-only field that displays the pin name associated with this button. Sensor Enter the name of the button. Sensitivity Select the appropriate value. Finger Threshold See Finger Threshold. FSS When Flanking Sensor Suppression (FSS) is disabled only one sensor is allowed to be "ON". When more than one sensor is touched simultaneously, only the first sensor that is touched is reported "ON" until it is released. This feature is required when the buttons are closely spaced, or when only one button must be "ON" at any time. To enable Flanking Sensor Suppression, select the check box for the corresponding button. This feature is disabled by default for all buttons. Initial/Subsequent Response Time See Initial/Subsequent Response Time Errors, Warnings, and Notes This section shows errors, warnings, and notes in the project. Errors indicate there is at least one problem that must be addressed before you can proceed with the project. Warnings report unusual conditions that might indicate a problem. Notes are informational messages from the system to indicate something occurred. At present, the system does not generate notes. EZ-Click 2.0 User Guide, Document # Rev *C 17

18 EZ-Click Framework 3.3 Global Configuration The Global configuration tab provides all the non-sensor device configuration settings. Sensor configuration settings are set using the CapSense sensor configuration tab. Note Some devices do not support all settings. So not all options on the tab will be available for all devices General Options Auto-reset period This period determines a maximum time the button can be in the "ON" state at any time. This feature is required to reduce the power consumption if any other conducting object (for example, a metal object), except the finger, is in contact with the button. As shown in the figure, when the CS0 is pressed for a long period of time, the GPO0 is not driven after the auto reset time. This helps in reducing the power consumption. The auto-reset period can be set to either 5 sec or 20 sec. When this feature is enabled, the sensor status will be reset, if the sensor is ON for a time that is greater than the configured time. When this feature is disabled the sensor will not be reset. Proximity auto-reset Select an appropriate value. I2C Address The device can be configured through I 2 C. Select the I 2 C slave address within the range from 0 to127 (in decimal). The default slave address is set to 55 (decimal). Optimization Select any one of the two options from the drop-down: Power consumption or Response time. The optimization parameter enables you to select either the optimum response time or the optimum power consumption. LED duration This is for the "Use LED Duration" feature. Select an appropriate value. State timeout This is the time before the device switches to low-power mode (see device datasheet for the real power mode names.) Select an appropriate value. Enable EMC noise immunity - This feature improves the noise immunity of the device against the external radiated and conducted noise. It also reduces the radiated noise emission. Enable shield Enables or disables the shield pin, which is used to enhance proximity and water rejection. Enable guard sensor Enable this option for the "guard" sensor, which when activated, prevents other sensors from being activated. 18 EZ-Click 2.0 User Guide, Document # Rev *C

19 EZ-Click Framework Enable GPIO host control Enable this option to allow the I 2 C master to control GPOs (instead of button-controlled GPOs). GPO drive mode Select an appropriate value to set strong drive or open drain (drive low only). GPO logic level Select an appropriate value to invert GPO values. Host interrupt pin Select an appropriate value to assert a signal when there is any change in sensor status. Buzzer The buzzer option is provided for the device, wherein a buzzer beeps when a button is touched. The buzzer works on a pulse-width modulator (PWM) signal given to it, which is dependent on the frequency and the duration of the pulse. The buzzer feature is present to get an audio output for a confirmation of the button touch. When the buzzer is enabled, the buzzer configuration parameters such as number of pins, frequency, output duration, and pin idle state are enabled. These features are disabled by default. Type: The buzzer can operate either in 1-pin or 2-pin mode. In the 1-pin mode, the PWM signal is sent through one pin, while the other pin of the buzzer is shorted to either positive or negative power supply. In the 2-pin mode, two PWM signals are sent to the buzzer through the two pins, both being non-overlapping. The Buzzer type can be selected from the drop-down menu. The type is set to 1-pin by default. Pin: None, HI/BUZ, CS5/SH/BUZ. The values vary depending on which device is selected Frequency: The buzzer frequency (khz) can be selected using this option. The choices available are 1, 1.14, 1.33, 1.6, 2, 2.67 and 4. The default value is 4. On time: The time is specified in milliseconds. The range depends on the device. Set the Buzzer ON time (msec) by clicking the up and down arrow. The desired value can also be entered in the box. Idle state: The buzzer idle state is set by selecting High or Low from the drop-down menu. This selects the idle state of pin-1 for the buzzer. This can be set to either High (VDD) or Low (Gnd). The default state is set to Low. Duration: Select an appropriate value. Supply voltage (V) Select a value to set the operating voltage selection register (DEVICE_CFG3), based on the operating voltage of the device. Note For MBR3 devices, applying a configuration that modifies this value will cause EZ-Click to lose its connection to the device. This will report a failure while programming because it was not able to verify that the changes took effect. This is expected. Once the device has been programmed with the new settings, you must reconfigure the board to handle the new voltage configuration. See the device data sheet for specific requirements. Debounce Select a value in the range from 1 to 255 for the various options, depending on the device. The debounce feature specifies the minimum time for which a contact has to be made with the sensor, for an output trigger. This time can vary for different situations. For example, the power button can have a high debounce time to avoid false switching (power-on or -off) of the device. If a fast response is required for an output, the debounce time should be low for the button. EZ-Click 2.0 User Guide, Document # Rev *C 19

20 EZ-Click Framework HCG Two general purpose digital output (GPO) pins are available, whose logic states can be controlled by the host. If the buzzer is not used then up to two more host controlled GPOs (HCGs) are available (using BuzzerOut0 and BuzzerOut1 pins). The following table shows the maximum available Host Controlled GPO pins, depending on the buzzer configuration. Buzzer Type Maximum Available Host Controlled GPOs Disabled 4 1 pin 3 2 pin LED Options Enable Select to enable the associated LED. Name Enter the name of the LED. Pin Read-only field that displays the pin name associated with this LED. Active duty cycle Select the PWM duty cycle for when the LED is active. Inactive Duty cycle Select the PWM duty cycle for when the LED is inactive. EZ-Click converts the duty cycle values into register values as follows: Selected% * 15 = RegisterValue For example: 100% * 15 = 15 20% * 15 = 3 Use LED Duration Enable or disable this option. Toggle Enable or disable this option. If this feature is enabled, the sensor remains "ON" when it is touched once, and does not turn OFF automatically. The next time the sensor is touched, the sensor turns OFF. Thus, the output toggles every time when the button is touched. This feature finds applications in situations where the button needs to be kept ON or OFF after it is touched. For example, the power button for a device needs to toggle every time when it is touched. Host control Enable or disable this option. 20 EZ-Click 2.0 User Guide, Document # Rev *C

21 EZ-Click Framework Errors, Warnings, and Notes See Errors, Warnings, and Notes. 3.4 Visual Configuration The Visual configuration tab is used to configure visual feedback effects, such as LED effects at power on and LED effects on button touch. Note At present, this tab is only used for CY8CMBR2xxx devices General Options LED Configuration LED on time When the LED ON time feature is enabled, it keeps the LED glowing for a predefined configured time even after the button is released. This feature is used to confirm the button press, if the touch is for a short duration of time. This time can be set in the LED ON time box and the valid range is 0 to 2000 ms in steps of 20 ms. The entered value is auto-corrected to the nearest valid duration. The default option is LED ON time disabled and the time duration set to 0. Analog voltage output This parameter decides whether output pins can be used as open-drain switches. If this feature is enabled, the output pins can be used for analog output voltage. If disabled, the output pins cannot be used for analog output voltage. The default option is set to disabled. LED standby brightness Defines the brightness levels of LEDs when the corresponding button is not pressed. Select one of the choices: 0%, 20%, 30%, or 50% LED State Periods Period1 - Period4 The different parameters for power-on LED effects and button controlled LED effects use four LED periods specified in msec. The desired value can also be entered in the box and their valid range is 0 to 2000 msec in steps of 20 msec. The entered value is auto-corrected to the nearest valid duration. The default value is 0. EZ-Click 2.0 User Guide, Document # Rev *C 21

22 EZ-Click Framework LED Effects at Power On LED effects mode Disabled, Concurrent, or Sequential. The default option is set to disabled. At Power-on, certain LED effects can be seen before initialization. You can define these effects by specifying the individual parameters for each LED. Table All the LEDs will have the defined effects for power on and/or button touch. The LEDs are divided into four groups, with three LEDs in each, except the first one. For each group, the different parameters can be set to vary the effects. The first four parameters are set by specifying one of the four available time periods, each of which is configured independently. Ramp up Time: Time taken by the LED to change state from low brightness to high brightness. High Time: Time duration for which the LED is in the High brightness state. Ramp down Time: Time taken by the LED to change state from high brightness to low brightness. Low Time: Time duration for which the LED is in the Low brightness state. High brightness: This sets the amount of brightness when the LED is in the High brightness state. Low brightness: This sets the amount of brightness when the LED is in the Low brightness state. LED Effect Repeat Rate: Defines the number of times the LED effects should be repeated after the button is released. 22 EZ-Click 2.0 User Guide, Document # Rev *C

23 EZ-Click Framework LED Effects on Button Touch On button touch Enable or disable the On button touch LED effects. The default option is set to disabled. The parameters for LEDs can be set to be different. The On button touch LED effects are of two types: breathing or non-breathing. Last button LED effect This parameter decides whether LED fading effects should continue on all the GPOs or only on the last button press or button release. If this feature is enabled, the LED fading effects only on the last button press or release. If disabled, the LED fading effects on any button press or release, based on the settings. The default option is set to disabled. Table This is the same table as LED Effects at Power On with one additional row: Breathing effect. All the LEDs will have the defined effects for power on and/or button touch. The LEDs are divided into four groups, with three LEDs in each, except the first one. For each group, the different parameters can be set to vary the effects. The first four parameters are set by specifying one of the four available time periods, each of which is configured independently. Breathing effects (button touch): In this mode, until the button is pressed, the LED will have the defined effect repeating. When the button is released the LED will have the defined effect for the number of times the repeat is set Errors, Warnings, and Notes See Errors, Warnings, and Notes. EZ-Click 2.0 User Guide, Document # Rev *C 23

24 EZ-Click Framework 3.5 CapSense Output This tab provides a graphical output. The output can be seen either for any particular button for multiple parameters (using the button specific output view) or for any particular parameter for multiple buttons (using the parameter specific output view). The output is shown in the form of a graph, with time (in msec or seconds) as the horizontal axis and the parameter that you chose as the vertical axis. The output for a specific time interval between the initial and the current time can be obtained using the position slider. You can move this slider position to view the data from the start of data acquisition. The play and stop buttons are used to run or hold the output General Options Select View Use to select Button Output or Parameter output. Displayed samples Use this to control the number of samples displayed in the graph. Sample period (ms) Use this to control the speed at which EZ-Click gathers data Button Output Options Button Select the specific button for which the output is to be monitored using the drop-down menu. Any button from Button0 to Button9 can be selected. By default, no button is selected, that is, the button specific output is disabled. 24 EZ-Click 2.0 User Guide, Document # Rev *C

25 EZ-Click Framework Finger Threshold By setting the finger threshold, you can evaluate the performance of the device from the graphs. This feature is available only if the automatic threshold calculation is disabled for the device. If the automatic threshold calculation is disabled, the finger threshold is set to 50 by default. This threshold should be set close to 80 percent of the difference count for a good response and noise immunity of the device. Button Status This field shows the ON/OFF status of the button. If no button is selected, the status field is left blank. C P This field shows the parasitic capacitance (C P) of the selected button. A button cannot function unless this capacitance is in the range of 5 to 41 pf. If no button is selected, this field is left blank. Graph The following are the options available: Raw count vs. base line When this option is selected, the graph displays the raw counts and base line values of the selected button, in different colors. For more information on raw counts and base line, see Finger Threshold section. Difference count and finger threshold When this option is selected, the graph displays the difference count and the finger threshold of the selected button, in different colors. The finger threshold should be 80 percent of the difference counts for a good design. If not, you may need to redesign the system. Difference count and finger threshold When this option is selected, the graph displays the difference count and the finger threshold of the selected button, in different colors. The finger threshold should be 80 percent of the difference counts for a good design. If not, you may need to redesign the system. Note This graph is only available if the "Automatic threshold" option is disabled in the CapSense Sensor Configuration tab. Signal to Noise ratio Signal-to-noise ratio (SNR) helps you to differentiate between the Touch, and the No Touch sensor states. The signal is the change in the sensor response when a finger is placed on the sensor. For the purpose of SNR calculation, the noise is the peak-topeak variation in the sensor response when a finger is not present (internal noise). When a finger touches the sensor surface there is a presence of the noise, but this is a combination of internal noise and noise injected through the finger. The noise introduced by the finger can affect the performance of the sensor, but, by definition, it is not part of the SNR calculation. For reliable CapSense performance, signal strength needs to be significantly larger than noise. The following figure is an example of signal and noise levels using real sensor data. In this example, the signal is a 135 count difference and the noise is a 27 count difference. Therefore, the SNR is 135:27, or 5:1. When this option is selected, the graph displays the SNR of the selected button. The horizontal axis is the samples and the vertical axis is the SNR. For a sturdy design, the SNR of the system should be more than 5:1. Note For MBR3 devices, EZ-Click is responsible for computing SNR, which requires a significant number of samples to establish a reasonable noise range. In order to establish this range, the tool should be allowed to collect at least 1000 data samples before a button press. Advanced low pass filter This option is only available for proximity sensors on MBR3 devices. When this option is selected, the graph displays the average filtered proximity raw count for the selected sensor Parameter Output Options Parameter select Select the respective parameter that has to be monitored using the drop-down menu. The different parameters are: Raw Count, Difference Count, and SNR. EZ-Click 2.0 User Guide, Document # Rev *C 25

26 EZ-Click Framework Buttons select Select the buttons for which the outputs are to be displayed using the checkbox provided for each button. You can select any button from Button0 to Button9. More than one button can also be selected. Therefore, you have the option to monitor only the buttons of your interest. Parameter graph The output graph displays the selected parameter for the selected buttons as a line graph. The horizontal axis is for the samples and the vertical axis is for the parameter selected. The output for different buttons is plotted in different colors. Thus, the parameters for different buttons can be compared using the graph. 3.6 System Diagnostics To test the device for functionality during the production line, use the System diagnostics tab. You can check the SNR and status of each button for the device. Also, the failure mode and effect analysis (FMEA) for the device can be done through this feature and you can see the FMEA results of the device. Thus, the device can be tested for faults using this tab Test Configuration Options Test mode Used to select Production vs. Prototype. Power on self test Enable or disable this field as applicable. Calibrated C P Read-only for Production. Use this field to view or set the parasitic capacitance (C P) tolerance. Calibrated SNR Read-only for Production. Use this field to view or set the calibrated SNR. You can select the minimum SNR required for specific needs and this sets the criteria to decide if a button passes or fails. The minimum SNR value can be selected within the range from 3 to 10, from 26 EZ-Click 2.0 User Guide, Document # Rev *C

27 EZ-Click Framework Table the drop-down menu. The value is set to 5 by default and it is recommended to keep a minimum SNR of 5:1. Calculate SNR for Select the sensor for which SNR will be calculated (MBR3 devices only). EZ- Click is responsible for computing SNR. This requires a significant amount of I 2 C traffic and only one sensor can be computed at a time. This option allows for selecting which sensor for which to compute SNR. Start/Stop Click the Start button to enter into testing mode and click Stop to exit from it. This table is active after pressing the Start button. Different information is shown in the table as different sensors are stimulated. Sensor Displays the name of the sensor. Status The status of the button is displayed in the status column. The status is?on? if a button is pressed; else it is?off?. The number of rows enabled is equivalent to the number of rows selected. SNR The tool displays the actual SNR of each button and also displays whether the button has passed or failed according to the minimum SNR required. A Pass is displayed if the respective read SNR is greater than or equal to the "minimum SNR required" value and "FAIL" if SNR is less than the "minimum SNR required." C P Displays the parasitic capacitance (C P) for the sensor. System Diagnostics Result The system diagnostics column shows whether each button has passed or failed the FMEA. The tool displays Pass in green if the button passes all the FMEA criteria and it displays fail code if a criterion is not met. If any button fails the FMEA, the corresponding fail code is specified for the button. Following is the list of various fail codes. C MOD out of range Button short to Gnd Button short to V DD Button to button short C P out of range Buttons Charts The following buttons are available for this tab: Load This brings up a file browser that allows opening a previously exported System Diagnostics log. Export This brings up a save file dialog that allows saving the collected system diagnostics data into a CSV file that can be opened in other tools. Reset This clears the currently collected System Diagnostics information and allows for a fresh start. This area displays after completing a test and pressing the Stop button. EZ-Click 2.0 User Guide, Document # Rev *C 27

28 EZ-Click Framework Number of tests Shows how many times a test was run. Check boxes to show or hide charts C P Chart SNR Chart Fault Condition Chart This page intentionally left blank. 28 EZ-Click 2.0 User Guide, Document # Rev *C

29 4 Menus and Toolbar EZ-Click has the following menus and toolbar: File Menu Configuration Menu Help Menu Toolbar 4.1 File Menu The EZ-Click File menu has the following commands: New Project Opens the Product Selector dialog to create a new project. See Creating a new project. Open Project Opens the Open Project dialog to select and open an existing project. See Opening an existing project. Save Project Saves any changes in the project to the current project file. See Saving a project. Save Project As Opens a Save As dialog to save the current project with a different project name. See Saving a project. Print Prints the current tab view as a screen image. See Printing the project. Print Preview Displays the current tab view as a screen image in a Print Preview window. See Printing the project. Recent Projects Allows you to view and select various previous existing projects. Exit Exits the EZ-Click program. See Exiting the tool. EZ-Click 2.0 User Guide, Document # Rev *C 29

30 Menus and Toolbar 4.2 Configuration Menu The EZ-Click Configuration menu has the following commands: Select Target Device Opens the Select I2C Target dialog to select the appropriate Cypress device. See Select I2C Target. Disconnect Target Disconnects EZ-Click from the connected device. Software Reset Issues a reset command to the connected device so it starts running from a fresh state. This is done automatically as part of the Apply Current Config command. Open Design Toolbox Opens the Design Toolbox xls file. The Design Toolbox provides general layout guidelines, layout estimator, Cp and Power value estimator, as well as design feasibility with actual data. Refer to the file for more information. Generate Config File Generates the config (*.iic) file used to program the device. Apply Current Config Programs the device. Open System Diagnostics Log Opens a <project_name>.csv file that contains various diagnostic data for different dates and times the device was last programmed. Reset Tab Resets the current tab to the default settings. See Reset. Reset All Tabs Resets all tabs to the default settings. See Reset. 4.3 Help Menu The EZ-Click Help menu has the following commands: Help Topics Opens the Help file. Documentation > Release Notes Opens the EZ Click Release Notes User Guide Opens the EZ Click User Guide About Opens the EZ-Click About box to view version and plug-in information. 30 EZ-Click 2.0 User Guide, Document # Rev *C

31 Menus and Toolbar 4.4 Toolbar The toolbar provides quick access to the most common functions, including: Command Shortcut Description See Also New Project Ctrl + N Opens the Device Selector dialog to create a new project. Creating a New Project Open Project Ctrl + O Opens dialog to select an existing project. Opening an existing project Save Project Ctrl + S Saves the current project. Saving a project Print Ctrl + P Prints the currently selected tab. Printing the project Open Design Toolbox Ctrl + T Opens a spreadsheet file that provides guidelines for setting up a CapSense project. Generate Config File Ctrl + G Saves the current project information to a configuration file that can be programmed onto the device. Generating the configuration file Apply Current Config Ctrl + L Programs the device with current configuration file. Program the target device Open System Diagnostics Log Ctrl + D Opens a file showing the log information from the last system diagnostic. Select Target Device Opens the Select I2C Target dialog to select the device. Select I2C Target Software Reset Issues a reset command to the connected device so it starts running from a fresh state. This is done automatically as part of the Apply Current Config command. EZ-Click 2.0 User Guide, Document # Rev *C 31

32 Menus and Toolbar This page intentionally left blank. 32 EZ-Click 2.0 User Guide, Document # Rev *C

33 5 Support Visit for online technical support. The resources include: Training Seminars Discussion Forums Application Notes Developer Community Knowledge Base Technical Support. You can also view and participate in discussion threads about a wide variety of PSoC device topics at Before using Cypress support services, confirm the version of EZ-Click installed on your system. Select Help > About to determine the tool version. Upgrades and version enhancements for the EZ-Click are provided by Cypress free of charge. The upgrades are available through the Cypress Update Manager. The Cypress Update Manager searches for updates to all Cypress products. EZ-Click 2.0 User Guide, Document # Rev *C 33

34 Support This page intentionally left blank. 34 EZ-Click 2.0 User Guide, Document # Rev *C

35 Index A Apply Configuration C Configuration file E Exit G Generate N New Project... 8 O Open Project... 9 P Preview Print R Reset tab S Save Project Support EZ-Click 2.0 User Guide, Document # Rev *C 35

36 Index This page intentionally left blank. 36 EZ-Click 2.0 User Guide, Document # Rev *C