TouchSystem Programmer's Guide

1 CARROLLTOUCHTOUCHPRODUCTS ancompanyAMPT ouchSystemProgrammer'sGuideTouch System programmer s GuideCARROLL TOUCHTOUCH PRODUCTSan AMP company Part #: 2970-0011-01-Rev AAugust 1996 CopyrightCopyright 1996 Carroll Touch. All rights is a trademark of Carroll Touch, Round Rock, and PC are trademarks of International Business Machines other brands and product names are trademarks of their respective Touch has a policy of continually improving products as new technology becomes available. Carroll Touch reserves the right to make changes and improvements to the specifications of this equipment at any time without Touch has made every attempt to ensure that the information in this document is accurate and complete. Carroll Touch assumes no liability for any damages that result from the use of this manual or the equipment it documents. Carroll Touch reserves the right to make changes to this document at any time without TOUCHT able of ContentsiTable of ContentsWelcome.

2 XiPurpose .. xiAudience .. xiOrganization .. xiConventions.. xiii1. Introduction to Infrared Touch Systems .. 1-1 Overview.. 1-2 Touch Frames .. 1-2 Touch Controller .. 1-2 Interpolating Touch Coordinates.. 1-3 Reporting Touch Coordinates .. 1-4 Failed Beams.. 1-4 Criteria for Failing a Beam .. 1-5 Failed Beam Timing Parameters.. 1-5 Criteria for Unfailing a Beam .. 1-7 Failed Beam Reports.. 1-72. Introduction to Guided Wave Touch Systems .. 2-1 Overview.. 2-2 Touch Screens .. 2-2 Touch Controllers .. 2-2 EEPROM File and Parameters .. 2-33. General Programming Issues .. 3-1 Hardware Configurations .. 3-2 Built-In Controllers .. 3-2 External Controllers.. 3-2 Application Program Interface .. 3-4 Calibration.. 3-6 Floating Point Calibration Program Design .. 3-7 Floating Point Calibration Examples.. 3-8 HBC I/O Registers.. 3-9 Overview.. 3-9 Sending a Touch Command to the HBC.

3 3-9 Receiving Touch Data from the HBC.. 3-10 Polling Mode.. 3-10 Interrupt Mode.. 3-11 Resetting the HBC.. 3-11 Table of ContentsCARROLL TOUCHii4. Smart-Frame Protocol .. 4-1 Overview.. 4-2 SFP and SFP-II .. 4-2 Types of SFP Commands .. 4-2 Communication Commands .. 4-3 Reporting Method Commands.. 4-3 Touch Mode Commands.. 4-4 Information Request Commands.. 4-5 System Commands .. 4-5 Reports.. 4-6 Touch System Initialization.. 4-7 Resetting the Touch System .. 4-7 Power Cycle.. 4-7 Dedicated Reset Signal .. 4-7 Break (Hardware Detected).. 4-7 HBC Hardware Reset Register .. 4-8 Break (Firmware Detected).. 4-8 Reset (45H) .. 4-8 Performing the Autobaud/Autoparity Sequence .. 4-8 Checking for Touch System Errors.. 4-9 Setting the Reporting Method and Touch Mode.. 4-10 Touch System Initialization Examples .. 4-10 Using Autobaud/Autoparity .. 4-10 Using a Fixed Baud Rate.. 4-11 Using the HBC.

4 4-11 Using an SBC .. 4-12 Compatibility Issues/Programming Tips.. 4-12 Number of Processors Independence .. 4-13 Firmware Version Independence.. 4-13 Frame Size Independence .. 4-13 Touch System Response Time Independence.. 4-13 SFP Timing .. 4-14 Autobaud/Autoparity Delay Time.. 4-14 Maximum Command Completion Time .. 4-14 Reset Time/Diagnostics Completion Time .. 4-14 SFP Programming Examples.. 4-145. Smart-Frame Protocol II .. 5-1 Overview.. 5-2 Extensibility.. 5-2 Modal Protocols.. 5-4 Backward Compatibility .. 5-4 Types of SFP-II Functions.. 5-5 Functions.. 5-5 CARROLL TOUCHT able of ContentsiiiCommands.. 5-6 Validation Layer .. 5-7 Interpretation Layer.. 5-7 Example.. 5-8 Reports.. 5-8 Validation Layer .. 5-9 Interpretation Layer.. 5-10 Example.. 5-10 Reporting Modes.. 5-11 Report Transfer Mode.. 5-11 Error Reporting .. 5-12 Invalid Command Number .. 5-12 Invalid Parameter Value.

5 5-13 Unsupported Feature .. 5-13 Invalid Byte Count.. 5-14 Not Enough Parameters.. 5-17 Too Many Parameters .. 5-17 Overloaded Functions .. 5-18 Shared Parameters between SFP and SFP-II.. 5-19 Touch Detection .. 5-19 Report Transfer .. 5-206. Touch Application Program Interface (TAPI) .. 6-1 Overview.. 6-2 Installing a TAPI Driver .. 6-3 SBC Driver .. 6-3 HBC Driver .. 6-4RS-232 Driver .. 6-4 Error Messages .. 6-6 Determining if a TAPI Driver Is Installed.. 6-7 Calling TAPI Functions.. 6-7 Touch System Initialization Using a TAPI Driver .. 6-8 TAPI Programming Examples.. 6-97. CTKERN .. 7-1 Overview.. 7-2 Calibration.. 7-2 Scaling.. 7-4 Touch Reporting .. 7-5 Calibration and Scaling Examples.. 7-5 Temporal Filter .. 7-8 Methods for Interfacing CTKERN and an Application Program.. 7-9 Polling Mode.. 7-9 Interrupt Mode.. 7-9 Table of ContentsCARROLL TOUCHivLoading the CTKERN Driver.

6 7-9 Command Line .. 7-9 Error Messages .. 7-10 Determining If the CTKERN Driver Is Installed .. 7-13 Calling CTKERN Functions .. 7-13 Command Line .. 7-14 Operation.. 7-15 Calibrate Mono, EGA, VGA Video Modes .. 7-16 Calibrate Other Video Modes .. 7-17 Edit Entry.. 7-18 Delete Entry.. 7-20 CTKERN Programming Examples.. 7-208. Dynamic Link Library (DLL) Functions .. 8-1 Calling Windows Driver DLL Functions .. 8-2A. Smart-Frame Protocol Command Reference .. A-1 Add_Exit_Point_Modifier (29H) ())..A-5 Clear_Touch_Report_Buffer (3DH) (=) ..A-6 Continuous_Mode (27H) ( ) ..A-7 Coordinate_Reporting (23H) (#)..A-8 Echo_Off (21H) (!) ..A-10 Echo_On (20H) (SPACE)..A-11 Enter_Point_Mode (25H) (%)..A-12 Exit_Point_Mode (28H) (()..A-13 Get_Configuration_Report (33H) (3) ..A-14 Get_Error_Report (32H) (2) ..A-15 Get_Failed_Beam_Report (36H) (6)..A-19 Get_Firmware_Version_Report (34H) (4).

7 A-21 Get_Frame_Size_Report (37H) (7)..A-23 Get_One_Report (46H) (F)..A-24 Get_State_Report (47H) (G)..A-25 Hardware_Flow_Control_Off (42H) (B)..A-27 Hardware_Flow_Control_On (41H) (A)..A-28 Report_Transfer_Off (43H) (C) ..A-29 Report_Transfer_On (44H) (D)..A-30 Reset (45H) (E) ..A-31 Run_Diagnostics (3AH) (:)..A-32 Scan_Reporting (22H) ( )..A-33 Software_Reset (3CH) (<)..A-34 SwitchToSFP-II (65H) ..A-35 Touch_Scanning_Off (2BH) (+)..A-37 CARROLL TOUCHT able of ContentsvTouch_Scanning_On (2AH) (*) ..A-38 Tracking_Mode (26H) (&) ..A-39B. Smart-Frame Protocol II Function Reference .. B-1 GetConfiguration (11H) ..B-3 GetCoordinateRanges (10H)..B-8 GetProtocolVersion (65H)..B-10 GetTouchState (01H)..B-12 SetReportProperties (21H) ..B-14 SetReportTransferMode (22H) ..B-19 SetTouchModes (20H) ..B-24 SwitchToClassicSFP (64H)..B-29C. TAPI Function Reference .. C-1 CheckForReports (3).

8 C-3 GetCommunicationParameters (4) ..C-4 GetReports (2)..C-6 GetTAPID riverConfiguration (6) ..C-7 GetUserEventHandlerParameters (8) ..C-8 Reset (0)..C-9 SendCommand (1)..C-10 SetCommunicationParameters (5)..C-11 SetSBCF rameSize (40H)..C-13 SetUserEventHandler (7)..C-14D. CTKERN Function Reference .. D-1 GetCalibrationTableEntry (7) ..D-5 GetCommunicationParameters (22) ..D-7 GetCTKERND riverConfiguration (20)..D-8 GetCurrentCalibrationModeAndParameters (5) ..D-9 GetCurrentScalingModeAndParameters (10) ..D-10 GetTAPID riverConfiguration (19) ..D-11 GetTemporalFilterModeAndParameters (16) ..D-12 GetTouchState (1) ..D-13 GetTouchSystemStatus/Configuration (17) ..D-15 GetUserEventHandlerModeAndParameters (25) ..D-16 GetZ-AxisScalingModeAndParameters (13) ..D-17 Reset (0)..D-18 SendSmart-FrameProtocolCommandAndGetRepo rt (18)..D-20 SetCalibrationMode (3)..D-22 SetCalibrationParameters (4).

9 D-23 SetCalibrationTableEntry (6) ..D-24 SetCommunicationParameters (21)..D-26 SetScalingMode (8)..D-28 Table of ContentsCARROLL TOUCHviSetScalingParameters (9)..D-29 SetTemporalFilterMode (14)..D-31 SetTemporalFilterParameters (15) ..D-34 SetTouchState (2) ..D-36 SetUserEventHandlerMode (23)..D-37 SetUserEventHandlerParameters (24)..D-39 SetZ-AxisScalingMode (11) ..D-40 SetZ-AxisScalingParameters (12)..D-41E. Dynamic Link Library (DLL) Function Reference E-1 DisableMouse (11) ..E-3 DisableTouch (12)..E-4 EnableMouse (9) ..E-5 EnableTouch (10) ..E-6 GetMouseInfo (13) ..E-7 GetTemporalFilterInfo (18)..E-8 GetTouchInfo (14)..E-9 GetTouchStateandCoord (5) ..E-10 InitializeTouch (16)..E-11 SetCalibInfo (7)..E-12 SetTemporalFilterInfo (17) ..E-14 SetTouchEvents (8)..E-16 Glossary ..GL-1 Index.. IN-1 CARROLL TOUCHT able of ContentsviiList of FiguresFigure 1-1. Infrared Touch Frame.

10 1-2 Figure 1-2. Beam Averaging - Example 1 .. 1-3 Figure 1-3. Beam Averaging - Example 2 .. 1-4 Figure 2-1. Guided Wave Touch Screen .. 2-2 Figure 3-1. Built-In Smart-Frame Controller Hardware .. 3-2 Figure 3-2. RS-232 Controller Hardware (Modular IR Touch Systems) .. 3-3 Figure 3-3. SBC and HBC Hardware (Modular IR Touch Systems) .. 3-4 Figure 3-4. Touch Control Software .. 3-5 Figure 3-5. Touch Calibration Screen .. 3-6 Figure 7-1. Touch System to Application Communication .. 7-3 Figure 7-2. Calibration Mode Fixed or Automatic and Scaling Mode Fixed or Automatic .. 7-6 Figure 7-3. Calibration Mode Fixed or Automatic and Scaling Mode Disabled .. 7-7 Figure 7-4. Calibration Mode Disabled and Scaling Mode Fixed or Automatic .. 7-7 Figure 7-5. Calibration Mode Disabled and Scaling Mode Disabled .. 7-8 Figure 7-6. Calibration Main Menu Screen .. 7-15 Figure 7-7. Calibration Menu Screen.