Trackpad Development Kit User Guide Using Arduino-Compatible Teensy 3.2 Hardware

Version 1.0

MAY2017

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 2

DocumentVersionHistoryDate CurrentVersion Description

MAY2017 1.0 InitialDocumentCreationNoticeThisdocumentisthesolepropertyofCirqueCorporation.TheinformationcontainedwithinisproprietarytoCirqueCorporation.Theholderofthisdocumentshalltreatallinformationcontainedhereinasconfidential,shallusetheinformationonlyforitsintendedpurpose,andshallprotecttheinformationinwholeorinpartfromduplication,disclosuretoanyotherparty,ordisseminationinanymediawithoutwrittenpermissionfromCirqueCorporation.NotetoPurchasers:Allspecificationssubjecttochangewithoutnotice.Cirqueshallnotbeliableforanydamageswhethernon-specified,direct,indirect,special,incidentalorconsequential(includingdowntime,lossofprofitorgoodwill)regardlessofthelegaltheoryasserted.Thisdocumentsupersedesallpreviousversions.Copyright,Trademark,andPatentInformationCopyright©2017CirqueCorporation.AllRightsReserved.Cirque®,theCirquelogo,GlidePoint®andtheGlidePointaretrademarksofCirqueCorporation.Allotherbrandnamesortrademarksarethepropertyoftheirrespectiveowners.Cirque'stouchcontrollerplatformsandtechnologysolutionsareprotectedbypatentsandadditionalU.S.andInternationalpatentspending.ContactCirqueformoreinformation.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 3

Table of Contents TableofContents...................................................................................................................3OverviewandSetUp..............................................................................................................4

Prerequisites....................................................................................................................................4InstallingtheDevelopmentEnvironment..........................................................................................4SettinguptheHardware...................................................................................................................5

ConnectionDetails...............................................................................................................................7

RunningtheTrackpadSketch.................................................................................................8ContactInformation..............................................................................................................12AppendixA–DevelopmentBoardSchematic........................................................................13AppendixB–TeensyBoardPinOut.......................................................................................15

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 4

Overview and Set Up ThisdocumentwilldescribehowtogetupandrunningwiththeCirquecirclesensordevelopmentkit.ThiskitutilizesahardwareplatformbasedonArduino1foreasydevelopment.

Prerequisites Ataminimum,thefollowingcomponentsarerequired:

• PC(WindowsorMacOS)withavailableUSBport.• CirqueGlidePointDevBoard(p/n:02-000620-00).ThisboardshouldhavetheTeensy3.2

Arduinocompatiblemodulepre-mounted.IfthisTeensy3.2isnotpre-mounteditwillneedtobeattachedtotheboardusingpluggableheaderpins(seeFigure1).

• Cirquetrackpadmoduleswith12-pinconnector(forexample,theTM040040PinnacleCircleTrackpad).

• USB-microcableforconnectingtheTeensy3.2tothecomputer.• 12-pinflatflexcableforconnectingthetrackpadtothedevboard.• Optionalcirclesensorholder.

CertaindevelopmentkitsfromCirque,suchastheCircleTrackpadDevKit(p/n:DK-000013-xx),provideacompletepackagewiththesecomponents.ContactaCirquesalesrepresentativefordetailsonhowtoobtainadevelopmentkit.

Installing the Development Environment 1. Ifnotalreadyinstalled,youmustdownloadandinstalltheArduinoIDE:

a. ArduinoIDEDownloadLink:https://www.arduino.cc/en/Main/Software

b. TheArduinoIDEdoesnotsupporttheTeensydevelopmentboardbydefault.Itwill

benecessarytoinstallaplug-incalled“Teensyduino”forTeensysupport.

i. TeensyduinoDownloadLink:https://www.pjrc.com/teensy/td_download.html.FollowtheinstructionsonthispagefortheinstallationofTeensyduinoforyouroperatingsystem.

ii. NOTE:TheTeensyduinoinstallermodifiestheArdunioIDEinstallation,whichmaycausesomeanti-virusprogramstoflagitasmalicious.Itmaybenecessarytodisableanti-virussoftwarepriortothisinstallation.

2. Nextyouwillneedtodownloadtheexamplecodefileforthetrackpadyouareusing.CirquemakesexamplecodeavailableatGitHub(https://github.com/cirque-corp).Foradirectlinktothespecificprojectyouareworkingon,consultthedocumentationorthewebpageforthattrackpad.Forexample,alinktotheCircleTrackpadGitHubsamplecodecanbefoundathttp://www.cirque.com/glidepoint-circle-trackpads.Youwillneedtolocatethespecific.inofileforthetrackpadprojectyouareworkingon.Arduinousesthefileextension

1ArduinoisatrademarkofArdunioAG.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 5

“.ino”forsourcefiles.Thesefilesaretext-onlyandcontainC/C++source.Thesearealsocalledsketches”inArduinoterminology.

Setting up the Hardware 1. Ifyourdevkitcamewithatrackpadholder,youmayattachittothedevelopmentboardfor

easeofuse.Theholderattachestothemountingholesinthecornerofthedevboard.Theremaybeasecondsmallerpiecethatconnectstotheothersidetohelpleveltheboard(seebelow).Theuseofthisholderisoptional,butitwillassistwiththeorientationofthetrackpadsduringdevelopment.

Figure1:Slidetheholdersothatitclipsintothecornermountingholesasshownabove.

2. Next,connectoneormoretrackpadmodulestothedevelopmentboard.Insertthe12-pinflatflexcable(FFC)totheconnectoronthetrackpadwiththecableconductorsfacingdown,thenfoldthelatchdowntolockitin.NOTE:ThesamplecodeprovidedbyCirqueonlyprovidessupportforONEsensoranditmustbeconnectedtotheSENSOR_0connector.Supportfortwosensorsiscomingsoon.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 6

Figure2:NotetheorientationoftheexposedFFCconductors.

3. OnthedevelopmentboardtheFFCconnectstotheSENSOR0andSENSOR1connectors.Notethattheexposedconductorsshouldbefacingdownwardonthissideoftheconnectionaswell.

Figure3:Connectiontothedevelopmentboard.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 7

Connection Details ThefullschematicforthedevelopmentboardcanbefoundinAppendixA.Keydetailscanbefoundbelow.ConnectionsforbothSPIandI2Ctrackpadsaresupported.Table1:SENSOR0PinOut

1 2 3 4 5 6 7 8 9 10 11 123.3V* GND SDA SCL BTN1 BTN3 BTN2 MOSI DR0** SS0** MISO SCK

Table1:SENSOR1PinOut

1 2 3 4 5 6 7 8 9 10 11 123.3V GND SDA SCL BTN1 BTN3 BTN2 MOSI DR1** SS1** MISO SCK

*NOTE:AheaderforthepowerconnectiononSENSOR0isprovidedsothatdeveloperscanmonitorpowerconsumption(labeledPOWER).ChecktoensurethatthejumperisinplacetoproperlypowerSENSOR0.**NOTE:Forthepurposesofidentifyingthecorrecttrackpadmodule,pins9and10areused(DATAREADYandSLAVESELECT).Itwillbenecessarytotargetthecorrectmodule(either0or1)inthesamplecode.Table3:HAPTICPinOut

1 2PLUS MINUS

AconnectorismadeavailableforexperimentingwithhapticdevicessuchastheAlps®HAPTIC™Reactor.ForfulldetailsseetheschematicinAppendixA.NOTE:Donotexceed80mAcurrentonthehapticconnector.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 8

Running the Trackpad Sketch OncethehardwareisassembledandtheArduinosoftwarehasbeeninstalledyouarereadytoconnectthehardwaretoacomputertobegincommunicatingwiththetrackpad.TheexamplebelowwilluseasketchthatoutputsX,Y,Zdataoveraserialportmonitortothecomputer.

1. ConnectthedevboardtothecomputerusingaUSBtoMicroUSBcable.2. OpentheArduinoIDE3. Opentheexamplecode“sketch”(.inofile)youwanttoload.4. ChecktomakesurethattheTeensy3.2isselectedunderthe“Tools>Boards”

menu.5. ChecktomakesureCPUSpeedissetto“96MHz(overclock)”

6. Clickthe“Verify”buttontocheckthecodeandcompileit.Thenselect“Upload”toprogramtheTeensyboard.Oncetheuploadiscomplete,pressthewhitebuttonontheTeensy3.2moduletoforceaprogram-load(thisistheonlywaytoensurenewcodeisuploaded)NOTE:thefirsttimecompilingthecodemaytakeawhile.Subsequentcompilationsaremuchfaster.AlsonotethatanadditionalwindowwillopenshowingtheTeensyLoaderwindowwhichwillalsodirectyoutopushthewhitebuttonontheTeensymodule.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 9

7. Oncetheloadingiscomplete,selectTools>PortandmakesurethattheTeensyisselectedastheserialport.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 10

8. Next,selectTools>SerialMonitor.

9. Thiswillopentheserialmonitorwindow.Intheexamplesketch,X,Y,Zdatapacketsaredisplayedinthiswindow.Youmaywanttoselect“Autoscroll”sothatthemostcurrentinformationisalwaysdisplayedinthewindow.NOTE:anyserialmonitorsoftwareshouldwork.BecausethisdeviceenumerateasUSBCDC,the“baudrate”settingshavenoeffect.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 11

Thisexamplesketchprovidesthefundamentalsforconnectingandreadingdatafromthetrackpad.Additionalsketchesformorefunctionality(suchascertaingesturesoroverlaytypes)areavailablefromcirque.comortheCirqueGitHubrepository.Thedevboardalsosupportsadditionalhardwareexperimentationviaa“breadboard”stylestructure.Usingthis,itiseasytoconnectanddevelopwithotherhardwarecomponentsforyourprojectaswellasconnectalogicanalyzertoseehowSPIandI2Ccommunicationishandled.SeetheschematicinAppendixAformoreinformation.ApinoutfortheTeensymoduleisalsoprovidedinAppendixB.Ifadditionalsupportisneededpleasecontactusatourwebsite,orviayourCirquesalesrepresentative.

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 12

Contact Information ContactaCirquesalesrepresentativeforatechnicalsupportoracompletelistofCirque'sOEMproducts. Website: www.cirque.com IntheUnitedStatesandCanada: (800)GLIDE-75(454-3375) OutsideUS&Canada: (801)467-1100 Fax: (801)467-0208

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 13

Appendix A – Development Board Schematic

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 14

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 15

Appendix B – Teensy Board Pin Out

TrackpadDevelopmentUsersGuide–DocumentVersionv1.0 16