UM0757 User manual S-TouchTM tuning window PC GUI over STEVAL-PCC009V1 1 Introduction This user manual explains the functions of the S-TouchTM tuning graphical user interface (GUI) over the STM32x-based STEVAL-PCC009V1 universal USB to serial communication interface (UUSCI). For details regarding the UUSCI demonstration board, please refer to UM0726. The objective of this user manual is to demonstrate how to use this GUI for the hardware tuning of S-Touch device-based touch boards (STMPE1208S and STMPE821). December 2010 Doc ID 16041 Rev 1 1/18 www.st.com Contents UM0757 Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3 4 2/18 2.1 System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.2 Package contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.3 Software installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.4 Hardware installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.5 Running the S-Touch tuning GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Using the S-Touch tuning window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.1 Selection of S-Touch devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.2 Connecting the board through the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.3 Opening the channel window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.4 Step 0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.5 Freezing the selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.6 Step 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.7 Step 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.8 Step 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Doc ID 16041 Rev 1 UM0757 List of figures List of figures Figure 1. Figure 2. Figure 3. Figure 4. Figure 5. Figure 6. Figure 7. Figure 8. Figure 9. Figure 10. Figure 11. Figure 12. Figure 13. Figure 14. Figure 15. Figure 16. Figure 17. Figure 18. Figure 19. Figure 20. Figure 21. Figure 22. Installation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 License Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Destination folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Installation ongoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Installation complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Enumeration result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Tuning window GUI menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Board is not connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Board is connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 S-Touch tuning window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Selection of appropriate S-Touch device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Connecting the board through the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Connecting the board through the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Opening the channel window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Channel window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Making the selection (check/uncheck) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Log file creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Freeze state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Step 1 output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Step 1 non-zero output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Step 2 output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Step 3 output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Doc ID 16041 Rev 1 3/18 Getting started UM0757 2 Getting started 2.1 System requirements In order to use the S-Touch tuning window GUI, a recent version of Windows(c), such as Windows 2000 or Windows XP must be installed on the PC. The version of the Windows OS installed on the PC may be determined by clicking on the "System" icon in the control panel. 2.2 Package contents The S-Touch tuning window consists of the following items: Software content: - Hardware content: - 2.3 S-Touch tuning GUI software to be used along with the demonstration board This GUI uses the STEVAL-PCC009V1 demonstration board Documentation: - User manual - Help file Software installation To install the PC GUI software, follow the steps below: Step 1: as soon as the setup.exe icon is clicked, the following window appears: Figure 1. Installation Window !-V 4/18 Doc ID 16041 Rev 1 UM0757 Getting started Step 2: read the license file and click the "Yes" button if accepted. Figure 2. License Window !-V Step 3: select the folder in which the software is to be installed. By default it installs the software in the following path - C:\....\STMicroelectronics\Universal Dongle GUI. Figure 3. Destination folder !-V Doc ID 16041 Rev 1 5/18 Getting started UM0757 Step 4: after selecting the folder and clicking the "Next" button, the software starts installing. Figure 4. Installation ongoing !-V Figure 5. Installation complete !-V After clicking the "Finish" button, the software has been installed in the directory selected or in the default directory. The shortcut for this software is available in the Start menu. This user manual is also available in the same directory. 6/18 Doc ID 16041 Rev 1 UM0757 2.4 Getting started Hardware installation Please refer to the UM0726 user manual for information regarding STEVAL-PCC009V1. 2.5 Running the S-Touch tuning GUI To run the S-Touch tuning window, it's necessary to use the STEVAL-PCC009V1 demonstration board. Please connect the demonstration board to the PC with the USB mini B-type cable. As a result, the demonstration board should be enumerated as universal serial bus controllers and is shown as "universal dongle demo board" in the device manager window, as shown in Figure 6. If this message does not appear, please contact technical support. Figure 6. Enumeration result !-V When starting the tuning GUI on the PC, a graphical interface (Figure 7) for controlling the demonstration board is seen. This PC software is used to issue various commands and to control data transfer. Figure 7. Tuning window GUI menu !-V Doc ID 16041 Rev 1 7/18 Getting started UM0757 You can check whether the board is connected or not by clicking the connection check button. If the board is not connected the following message appears: Figure 8. Board is not connected !-V If the board is connected the following message appears: Figure 9. Board is connected !-V Once this is done, the PC GUI is properly connected to the demonstration board and ready for use. 8/18 Doc ID 16041 Rev 1 UM0757 3 Using the S-Touch tuning window Using the S-Touch tuning window After completing the steps to run the S-Touch tuning GUI (shown in Section 3), the following GUI opens. Figure 10. S-Touch tuning window AM04486v1 Follow these steps (listed) to fine tune a daughterboard. Selection of S-Touch devices Connecting the board through the GUI Opening of channel window Step 0 Freezing the selection and unit factor Step 1 Step 2 Step 3 Doc ID 16041 Rev 1 9/18 Using the S-Touch tuning window 3.1 UM0757 Selection of S-Touch devices Figure 11. Selection of appropriate S-Touch device !-V Select the appropriate daughterboard that is to be tuned before connecting the board through the GUI. 3.2 Connecting the board through the GUI The board can be connected through the GUI in either of the following two ways. Figure 12. Connecting the board through the GUI !-V Figure 13. Connecting the board through the GUI !-V 10/18 Doc ID 16041 Rev 1 UM0757 3.3 Using the S-Touch tuning window Opening the channel window Figure 14. Opening the channel window !-V The channel window, which assists in fine tuning the board, can be opened from here. The channel window appears as follows: Figure 15. Channel window AM04491v1 Doc ID 16041 Rev 1 11/18 Using the S-Touch tuning window 3.4 UM0757 Step 0 In this step it's possible to select the channels to be tuned. For instance, if just three channels are to be tuned, uncheck all the other channels except channel one, two and three. Once done, the user can proceed to freeze the selection as well as the entered unit factor for the selected board. Figure 16. Making the selection (check/uncheck) AM04492v1 Figure 16 depicts the selection of the channels to be tuned. In this example, the first three channels of STMPE1208S are to be tuned. Therefore, the respective channels are checked and the unit factor is entered for STMPE1208S. The user can then proceed to freeze this selection by clicking on the freeze button. 12/18 Doc ID 16041 Rev 1 UM0757 3.5 Using the S-Touch tuning window Freezing the selection Freeze the selection by clicking on the freeze button. When the button is green it indicates that it is enabled and when red it indicates that it is completed and disabled. On freezing, the GUI asks the user whether to create the log file or not. The user can enter the path where the file is to be created, as shown below: Figure 17. Log file creation !-V The GUI appears as follows on freezing: Figure 18. Freeze state AM04494v1 Doc ID 16041 Rev 1 13/18 Using the S-Touch tuning window 3.6 UM0757 Step 1 The purpose of step 1 is to set the impedance values as non-zero. To do this, the GUI guides the user when adding some capacitance on the CREF of the attached daughterboard. The user can then mount that capacitance value on the CREF and re-attach the board. The GUI then gives the channel reading after mounting the capacitance. If any channel value is still non-zero, it asks the user to repeat step 1. Once the values are non-zero, step 1 is disabled (indicated in red) and the next step to be executed is enabled (indicated in green). Figure 19. Step 1 output AM04495v1 This shows that the minimum capacitance the user should add is 3.6 pF, and if the capacitor of value 3.6 pF is not available, the user can set the capacitance value up to 3.6 +1.3 pF. 14/18 Doc ID 16041 Rev 1 UM0757 3.7 Using the S-Touch tuning window Step 2 Step 2 guides the user when adding capacitances to the individual channels to bring the channel values to default level. The capacitance to be added to each channel is displayed under the CC column. For instance, the capacitance values for STMPE821 touch channels, after step 1, become non-zero, as shown in Figure 20: Figure 20. Step 1 non-zero output AM04496v1 As shown, the user can now proceed to step two, as step one output has become non-zero. The step 2 button turns green which means it's enabled. Figure 21. Step 2 output AM04497v1 In this case the CC value is zero, therefore it's not necessary to mount any capacitance on the individual channels. Step 3 is now enabled. Doc ID 16041 Rev 1 15/18 Using the S-Touch tuning window 3.8 UM0757 Step 3 In step 3, the value for REF_DELAY is calculated and logged into the log file, created for user reference. It guides the user when mounting capacitance on channels to bring their values in range. Figure 22. Step 3 output AM04498v1 In this step, the GUI continues referring the channel capacitances to be added until the channel values are in range. When all the channel values are in the desired range for tuning, the process is completed and the user can then close the application. Finally, the user can refer to the log file, created during the tuning process, to know the various tuning parameters for the respective daughterboard. 16/18 Doc ID 16041 Rev 1 UM0757 4 Revision history Revision history Table 1. Document revision history Date Revision 10-Dec-2010 1 Changes Initial release. Doc ID 16041 Rev 1 17/18 UM0757 Please Read Carefully: Information in this document is provided solely in connection with ST products. STMicroelectronics NV and its subsidiaries ("ST") reserve the right to make changes, corrections, modifications or improvements, to this document, and the products and services described herein at any time, without notice. All ST products are sold pursuant to ST's terms and conditions of sale. Purchasers are solely responsible for the choice, selection and use of the ST products and services described herein, and ST assumes no liability whatsoever relating to the choice, selection or use of the ST products and services described herein. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted under this document. If any part of this document refers to any third party products or services it shall not be deemed a license grant by ST for the use of such third party products or services, or any intellectual property contained therein or considered as a warranty covering the use in any manner whatsoever of such third party products or services or any intellectual property contained therein. UNLESS OTHERWISE SET FORTH IN ST'S TERMS AND CONDITIONS OF SALE ST DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY WITH RESPECT TO THE USE AND/OR SALE OF ST PRODUCTS INCLUDING WITHOUT LIMITATION IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE (AND THEIR EQUIVALENTS UNDER THE LAWS OF ANY JURISDICTION), OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. UNLESS EXPRESSLY APPROVED IN WRITING BY AN AUTHORIZED ST REPRESENTATIVE, ST PRODUCTS ARE NOT RECOMMENDED, AUTHORIZED OR WARRANTED FOR USE IN MILITARY, AIR CRAFT, SPACE, LIFE SAVING, OR LIFE SUSTAINING APPLICATIONS, NOR IN PRODUCTS OR SYSTEMS WHERE FAILURE OR MALFUNCTION MAY RESULT IN PERSONAL INJURY, DEATH, OR SEVERE PROPERTY OR ENVIRONMENTAL DAMAGE. ST PRODUCTS WHICH ARE NOT SPECIFIED AS "AUTOMOTIVE GRADE" MAY ONLY BE USED IN AUTOMOTIVE APPLICATIONS AT USER'S OWN RISK. Resale of ST products with provisions different from the statements and/or technical features set forth in this document shall immediately void any warranty granted by ST for the ST product or service described herein and shall not create or extend in any manner whatsoever, any liability of ST. ST and the ST logo are trademarks or registered trademarks of ST in various countries. Information in this document supersedes and replaces all information previously supplied. The ST logo is a registered trademark of STMicroelectronics. All other names are the property of their respective owners. (c) 2010 STMicroelectronics - All rights reserved STMicroelectronics group of companies Australia - Belgium - Brazil - Canada - China - Czech Republic - Finland - France - Germany - Hong Kong - India - Israel - Italy - Japan Malaysia - Malta - Morocco - Philippines - Singapore - Spain - Sweden - Switzerland - United Kingdom - United States of America www.st.com 18/18 Doc ID 16041 Rev 1