Newport XPS-Q Manuals

Manuals and User Guides for Newport XPS-Q. We have 1 Newport XPS-Q manual available for free PDF download: Programmer's Manual

Newport XPS-Q Programmer's Manual

Newport XPS-Q Programmer's Manual (722 pages)

XPS Unified Series Universal High-Performance Motion Controller/Driver

Brand: Newport | Category: Controller | Size: 6.72 MB

Table of Contents

Table of Contents
3
1 Note

15
2 TCP/IP Communication

16
3 XPS .NET Software Drivers

17
4 TCP/IP Support Functions

25
- Openinstrument
  25
- Closeinstrument
  26
- Settimeout
  26
5 XPS Standard Firmware Architecture (Base Version)

27
- Group Definition
  27
  - Object Structure
    27
- Positioner Definition
  28
  - Object Structure
    28
  - Definition of the Positions Available for each Positioner
    29
- Singleaxis Group
  30
  - State Diagram
    31
- Spindle Group
  32
  - State Diagram
    33
- XY Group
  34
  - State Diagram
    35
- XYZ Group
  36
  - State Diagram
    37
- Multipleaxes Group
  38
  - State Diagram
    39
- Analog and Digital I/O
  40
  - GPIO Name List
    40
    
    XPS-Q Hardware
    40
    
    XPS-RL or XPS-D Hardware
    41
6 XPS Extended Firmware Architecture (Contact Newport)

42
- Singleaxiswithclamping Group
  42
  - State Diagram
    43
  - Group Clamping Sequence
    44
    
    Clamping State Diagram
    44
- Singleaxistheta Group
  45
  - State Diagram
    46
  - Group Clamping Sequence
    47
    
    Clamping State Diagram
    47
- TZ Group
  48
  - State Diagram
    49
- User External Module Programming
  50
- ZYGO Interferometer
  51
7 XPS Functions Description

56
- Input Tests Common to All XPS Functions
  56
- XPS Functions Lists
  57
  - Standard Functions
    57
    
    Cleancoredumpfolder
    57
    
    Cleantmpfolder
    58
    
    Closeallothersockets
    59
    
    Controllermotionkerneltimeloadget
    60
    
    Controllerrttimeget
    61
    
    Controllerslavestatusget
    62
    
    Controllerslavestatusstringget
    63
    
    Controllerstatusget
    64
- Controllerstatusread
  65
- Controllerstatusstringget
  66
- Controllersynchronizecorrectorisr
  67
- Datacollectionbufferreset
  68
- Datacollectionbufferandtimereset
  69
- Datacollectionrequest
  70
- Datacollectiontimestampget
  71
- Datacollectiontimestampreset
  72
- Doubleglobalarrayget
  73
- Doubleglobalarrayset
  74
- Elapsedtimeget
  75
- Errorstringget
  76
- Eventextendedallget
  77
- Eventextendedconfigurationactionget
  78
- Eventextendedconfigurationactionset
  79
- Eventextendedconfigurationtriggerget
  81
- Eventextendedconfigurationtriggerset
  82
- Eventextendedget
  84
- Eventextendedremove
  85
- Eventextendedstart
  86
- Eventextendedwait
  88
- Externalmodulefirmwareversionget
  90
- Externalmodulescanfunctimedurationsget
  91
- Externalmodulesocketfree
  92
- Externalmodulesocketreserve
  93
- Filegatheringrename
  94
- Filescripthistoryrename
  95
- Firmwarebuildversionnumberget
  96
- Firmwareversionget
  97
- Gatheringconfigurationget
  98
- Gatheringconfigurationset
  99
- Gatheringcurrentnumberget
  100
- Gatheringdataacquire
  101
- Gatheringdataget
  102
- Gatheringdatamultiplelinesget
  103
- Gatheringexternalconfigurationget
  105
- Gatheringexternalconfigurationset
  106
- Gatheringexternalcurrentnumberget
  107
- Gatheringexternaldataget
  108
- Gatheringexternalstopandsave
  109
- Gatheringreset
  110
- Gatheringrun
  111
- Gatheringrunappend
  112
- Gatheringstop
  113
- Gatheringstopandsave
  114
- Getlibraryversion
  115
- Globalarrayget
  116
- Globalarrayset
  117
- Gpioanaloggainget
  118
- Gpioanaloggainset
  119
- Gpioanalogget
  120
- Gpioanalograngeconfigurationget
  121
- Gpioanalograngeconfigurationset
  122
- Gpioanalogset
  123
- Gpiodigitalget
  124
- Gpiodigitalset
  125
- Gpiodigitalpulsewidthget
  126
- Gpiodigitalpulsewidthset
  127
- Groupaccelerationcurrentget
  128
- Groupaccelerationsetpointget
  129
- Groupanalogtrackingmodedisable
  130
- Groupanalogtrackingmodeenable
  131
- Groupbrakestateget
  133
- Groupbrakeset
  134
- Groupcorrectoroutputget
  135
- Groupcurrentfollowingerrorget
  136
- Groupgantrymodeget
  137
- Groupgantrymodeset
  138
- Grouphomesearch
  139
- Grouphomesearchandrelativemove
  141
- Groupinitialize
  143
- Groupinitializenoencoderreset
  145
- Groupinitializewithencodercalibration
  147
- Groupinterlockdisable
  149
- Groupinterlockenable
  150
- Groupjogcurrentget
  151
- Groupjogmodedisable
  153
- Groupjogmodeenable
  154
- Groupjogparametersget
  156
- Groupjogparametersset
  158
- Groupkill
  160
- Groupmotiondisable
  161
- Groupmotionenable
  162
- Groupmotionstatusget
  163
- Groupmoveabort
  164
- Groupmoveabortfast
  166
- Groupmoveabsolute
  168
- Groupmoveendwait
  170
- Groupmoverelative
  171
- Grouppositioncurrentget
  173
- Grouppositionsetpointget
  174
- Grouppositiontargetget
  175
- Groupreferencingactionexecute
  176
- Groupreferencingstart
  178
- Groupreferencingstop
  179
- Groupspincurrentget
  180
- Groupspinmodestop
  181
- Groupspinparametersget
  182
- Groupspinparametersset
  183
- Groupstatusget
  185
- Groupstatusstringget
  186
- Groupvelocitycurrentget
  187
- Groupvelocitysetpointget
  188
- Hardwaredateandtimeget
  189
- Hardwaredateandtimeset
  190
- Hardwaredriverandstageget
  191
- Installerversionget
  192
- Intservitudescommandget
  193
- Intservitudesstatusget
  194
- Killall
  195
- Login
  196
- Logins
  197
- Multipleaxesptexecution
  198
- Multipleaxesptloadtomemory
  200
- Multipleaxesptparametersget
  202
- Multipleaxesptpulseoutputget
  203
- Multipleaxesptpulseoutputset
  205
- Multipleaxesptresetinmemory
  207
- Multipleaxesptverification
  208
- Multipleaxesptverificationresultget
  210
- Multipleaxespvtexecution
  211
- Multipleaxespvtloadtomemory
  213
- Multipleaxespvtparametersget
  215
- Multipleaxespvtpulseoutputget
  216
- Multipleaxespvtpulseoutputset
  218
- Multipleaxespvtresetinmemory
  220
- Multipleaxespvtverification
  221
- Multipleaxespvtverificationresultget
  223
- Openconnection
  224
- Positioneraccelerationautoscaling
  225
- Positioneranalogtrackingpositionparametersget
  227
- Positioneranalogtrackingpositionparametersset
  228
- Positioneranalogtrackingvelocityparametersget
  230
- Positioneranalogtrackingvelocityparametersset
  232
- Positionerbacklashdisable
  234
- Positionerbacklashenable
  235
- Positionerbacklashget
  237
- Positionerbacklashset
  238
- Positionercompensatedfastpcoabort
  239
- Positionercompensatedfastpcocurrentstatusget
  240
- Positionercompensatedfastpcoenable
  241
- Positionercompensatedfastpcofromfile
  242
- Positionercompensatedfastpcoloadtomemory
  244
- Positionercompensatedfastpcomemoryreset
  245
- Positionercompensatedfastpcoprepare
  246
- Positionercompensatedfastpcopulseparametersget
  248
- Positionercompensatedfastpcopulseparametersset
  249
- Positionercompensatedfastpcoset
  250
- Positionercompensatedpcoabort
  252
- Positionercompensatedpcocurrentstatusget
  254
- Positionercompensatedpcoenable
  255
- Positionercompensatedpcofromfile
  257
- Positionercompensatedpcoloadtomemory
  259
- Positionercompensatedpcomemoryreset
  261
- Positionercompensatedpcoprepare
  262
- Positionercompensatedpcoset
  264
- Positionercompensationdisturbancedisable
  266
- Positionercompensationdisturbanceenable
  267
- Positionercompensationdisturbancefileload
  268
- Positionercompensationdisturbancestatusget
  269
- Positionercompensationdualloopnotchfilterget
  270
- Positionercompensationdualloopnotchfilterset
  272
- Positionercompensationdualloopphasecorrectionfilterget
  274
- Positionercompensationdualloopphasecorrectionfilterset
  276
- Positionercompensationencodernotchfilterget
  278
- Positionercompensationencodernotchfilterset
  280
- Positionercompensationfrequencynotchsget
  282
- Positionercompensationfrequencynotchsset
  284
- Positionercompensationlowpasstwofilterget
  286
- Positionercompensationlowpasstwofilterset
  287
- Positionercompensationnotchfilterget
  288
- Positionercompensationnotchfilterset
  289
- Positionercompensationnotchmodefiltersget
  291
- Positionercompensationnotchmodefiltersset
  293
- Positionercompensationphasecorrectionfilterget
  295
- Positionercompensationphasecorrectionfilterset
  297
- Positionercompensationphasecorrectionfiltersget
  299
- Positionercompensationphasecorrectionfiltersset
  301
- Positionercompensationpositionfilterget
  303
- Positionercompensationpositionfilterset
  304
- Positionercompensationpostexcitationfrequencynotchfilterget
  305
- Positionercompensationpostexcitationfrequencynotchfilterset
  306
- Positionercompensationpostexcitationlowpassfilterget
  308
- Positionercompensationpostexcitationlowpassfilterset
  309
- Positionercompensationpostexcitationnotchmodefilterget
  310
- Positionercompensationpostexcitationnotchmodefilterset
  312
- Positionercompensationpostexcitationphasecorrectionfilterget
  314
- Positionercompensationpostexcitationphasecorrectionfilterset
  316
- Positionercompensationprefeedforwardfrequencynotchfilterget
  318
- Positionercompensationprefeedforwardfrequencynotchfilterset
  319
- Positionercompensationprefeedforwardphasecorrectionfilterget
  321
- Positionercompensationprefeedforwardphasecorrectionfilterset
  323
- Positionercompensationprefeedforwardspatialnotchfilterget
  325
- Positionercompensationprefeedforwardspatialnotchfilterset
  326
- Positionercompensationspatialperiodicnotchsget
  328
- Positionercompensationspatialperiodicnotchsset
  330
- Positionercorrectorautotuning
  332
- Positionercorrectordamperfilterget
  334
- Positionercorrectordamperfilterset
  335
- Positionercorrectordualget
  337
- Positionercorrectordualset
  339
- Positionercorrectorexcitationsignalgainget
  341
- Positionercorrectorexcitationsignalgainset
  342
- Positionercorrectornotchfiltersget
  343
- Positionercorrectornotchfiltersset
  345
- Positionercorrectorpidaccelerationfilterget
  347
- Positionercorrectorpidaccelerationfilterset
  348
- Positionercorrectorpidbaseget
  349
- Positionercorrectorpidbaseset
  351
- Positionercorrectorpiddualffvoltageget
  353
- Positionercorrectorpiddualffvoltageset
  355
- Positionercorrectorpidffaccelerationget
  358
- Positionercorrectorpidffaccelerationset
  360
- Positionercorrectorpidffvelocityget
  362
- Positionercorrectorpidffvelocityset
  364
- Positionercorrectorpipositionget
  366
- Positionercorrectorpipositionset
  367
- Positionercorrectorplantfeedforwarddelayget
  369
- Positionercorrectorplantfeedforwarddelayset
  370
- Positionercorrectorpostffget
  371
- Positionercorrectorpostffset
  372
- Positionercorrectortypeget
  373
- Positionercurrentvelocityaccelerationfiltersget
  374
- Positionercurrentvelocityaccelerationfiltersset
  375
- Positionerdriverfiltersget
  377
- Positionerdriverfiltersset
  378
- Positionerdriverpositionoffsetsget
  380
- Positionerdriverstatusget
  381
- Positionerdriverstatusstringget
  382
- Positionerencoderamplitudevaluesget
  383
- Positionerencodercalibrationparametersget
  384
- Positionersencoderindexdifferenceget
  386
- Positionererrorget
  387
- Positionererrorread
  388
- Positionererrorstringget
  389
- Positionerexcitationsignalget
  390
- Positionerexcitationsignalset
  391
- Positionerexcitationsignalcorrectoroutset
  394
- Positionerfeedforwardaccdisable
  397
- Positionerfeedforwardaccenable
  398
- Positionerfeedforwardaccget
  399
- Positionerfeedforwardaccset
  400
- Positionerfeedforwardpositiondisable
  402
- Positionerfeedforwardpositionenable
  403
- Positionerfeedforwardpositionget
  404
- Positionerfeedforwardpositionset
  405
- Positionergantryendreferencingpositionget
  406
- Positionerhardinterpolatorfactorget
  407
- Positionerhardinterpolatorfactorset
  408
- Positionerhardinterpolatorpositionget
  410
- Positionerhardwarestatusget
  411
- Positionerhardwarestatusstringget
  412
- Positionerjogmaximumvelocityandaccelerationget
  413
- Positionermagnetictrackpositionathomeget
  414
- Positionermaximumvelocityandaccelerationget
  415
- Positionermotiondoneget
  416
- Positionermotiondoneset
  417
- Positionermotordualsinforcebalanceget
  418
- Positionermotordualsinforcebalanceset
  419
- Positionerpositioncompareaquadbalwaysenable
  420
- Positionerpositioncompareaquadbprescalerget
  421
- Positionerpositioncompareaquadbprescalerset
  422
- Positionerpositioncompareaquadbwindowedget
  423
- Positionerpositioncompareaquadbwindowedset
  424
- Positionerpositioncomparedisable
  426
- Positionerpositioncompareenable
  427
- Positionerpositioncompareget
  428
- Positionerpositioncomparepulseparametersget
  429
- Positionerpositioncomparepulseparametersset
  430
- Positionerpositioncomparescanaccelerationlimitget
  432
- Positionerpositioncomparescanaccelerationlimitset
  433
- Positionerpositioncompareset
  434
- Positionerprecorrectorexcitationsignalget
  436
- Positionerprecorrectorexcitationsignalset
  437
- Positionerrawencoderpositionget
  439
- Positionersgammaexactvelocityajusteddisplacementget
  440
- Positionersgammaparametersget
  441
- Positionersgammaparametersset
  442
- Positionersgammapreviousmotiontimesget
  444
- Positionersgammavelocityandaccelerationset
  445
- Positionerstageparameterget
  446
- Positionerstageparameterset
  447
- Positionertimeflasherdisable
  448
- Positionertimeflasherenable
  449
- Positionertimeflasherget
  450
- Positionertimeflasherset
  451
- Positionerusertravellimitsget
  453
- Positionerusertravellimitsset
  454
- Positionerwarningfollowingerrorget
  455
- Positionerwarningfollowingerrorset
  456
- Reboot
  457
- Restartapplication
  458
- Singleaxisslavemodedisable
  459
- Singleaxisslavemodeenable
  460
- Singleaxisslaveparametersget
  461
- Singleaxisslaveparametersset
  462
- Singleaxisthetaclampdisable
  464
- Singleaxisthetaclampenable
  465
- Singleaxisthetafeedforwardjerkparametersget
  466
- Singleaxisthetafeedforwardjerkparametersset
  467
- Singleaxisthetafeedforwardparametersget
  468
- Singleaxisthetafeedforwardparametersset
  469
- Singleaxisthetaslavemodedisable
  470
- Singleaxisthetaslavemodeenable
  471
- Singleaxisthetaslaveparametersget
  472
- Singleaxisthetaslaveparametersset
  473
- Spindleslavemodedisable
  475
- Spindleslavemodeenable
  476
- Spindleslaveparametersget
  477
- Spindleslaveparametersset
  478
- Tclscriptexecute
  480
- Tclscriptexecuteandwait
  481
- Tclscriptexecutewithpriority
  483
- Tclscriptkill
  485
- Tclscriptkillall
  486
- Tclscriptrunninglistget
  487
- Tcp_Closesocket
  488
- Tcp_Connecttoserver
  489
- Tcp_Geterror
  490
- Tcp_Settimeout
  491
- Timerget
  492
- Timerset
  493
- Tzencodercouplingmatrixget
  494
- Tzencodercouplingmatrixset
  496
- Tzencodercouplingmodeget
  498
- Tzencodercouplingmodeset
  499
- Tzfocusmodedisable
  500
- Tzfocusmodeenable
  501
- Tzmappingmodeget
  502
- Tzmappingmodeset
  503
- Tzmotordecouplingmatrixget
  504
- Tzmotordecouplingmatrixset
  506
- Tzmotordecouplingmodeget
  508
- Tzmotordecouplingmodeset
  509
- Tzptexecution
  510
- Tzptloadtomemory
  512
- Tzptparametersget
  514
- Tzptpulseoutputget
  515
- Tzptpulseoutputset
  517
- Tzptresetinmemory
  519
- Tzptverification
  520
- Tzptverificationresultget
  522
- Tzpvtexecution
  524
- Tzpvtloadtomemory
  526
- Tzpvtparametersget
  528
- Tzpvtpulseoutputget
  529
- Tzpvtpulseoutputset
  531
- Tzpvtresetinmemory
  533
- Tzpvtverification
  534
- Tzpvtverificationresultget
  536
- Tztrackingcutofffrequencyget
  538
- Tztrackingcutofffrequencyset
  539
- Tztrackingusermaximumzzztargetdifferenceget
  540
- Tztrackingusermaximumzzztargetdifferenceset
  541
- Xycrosstalkcompensationmotordecouplingget
  542
- Xycrosstalkcompensationmotordecouplingset
  543
- Xygrouppositioncorrectedprofilerget
  544
  - Xygrouppositionpcorawencoderget
    546
  - Xylinearcexecution
    547
  - Xylinearcparametersget
    549
  - Xylinearcpulseoutputget
    550
  - Xylinearcpulseoutputset
    552
  - Xylinearcverification
    554
  - Xylinearcverificationresultget
    556
  - Xymappingget
    557
  - Xymappingset
    559
  - Xyptexecution
    561
  - Xyptloadtomemory
    563
  - Xyptparametersget
    565
  - Xyptpulseoutputget
    566
  - Xyptpulseoutputset
    568
  - Xyptresetinmemory
    570
  - Xyptverification
    571
  - Xyptverificationresultget
    573
  - Xypvtexecution
    575
  - Xypvtloadtomemory
    577
  - Xypvtparametersget
    579
  - Xypvtpulseoutputget
    580
  - Xypvtpulseoutputset
    582
  - Xypvtresetinmemory
    584
  - Xypvtverification
    585
  - Xypvtverificationresultget
    587
  - Xyzgrouppositioncorrectedprofilerget
    589
  - Xyzgrouppositionpcorawencoderget
    591
  - Xyzsplineexecution
    593
  - Xyzsplineparametersget
    595
  - Xyzsplinepulseoutputget
    596
  - Xyzsplinepulseoutputset
    598
  - Xyzsplineverification
    600
  - Xyzsplineverificationresultget
    602
- Extended Functions
  603
  - Abortmove
    603
  - Endjog
    604
  - Getaccparams
    605
  - Getbrakestate
    606
  - Getcurrentposition
    607
  - Getgantrymode
    608
  - Getjogacceleration
    609
  - Getjogvelocity
    610
  - Getpistonstate
    611
  - Getvarx
    613
  - Getvarxsecondary
    614
  - Getvary
    615
  - Getvelparams
    616
  - Getvercommand
    617
  - Getxvelparams
    618
  - Getyvelparams
    619
  - Getzone
    620
- Initializeandhomex
  621
- Initializeandhomexy
  623
- Initializeandhomey
  625
- Moveabsolute
  627
- Moveslice
  629
- Requesttype1
  631
- Requesttype2
  633
- Requesttype3
  634
- Setaccparams
  635
- Setbrake
  636
- Setgantrymode
  637
- Setjogacceleration
  639
- Setjogvelocity
  641
- Setpiston
  643
- Setvarx
  644
- Setvarxsecondary
  645
- Setvary
  646
- Setvelparams
  647
- Setxvelparams
  648
- Setyvelparams
  649
- Setzone
  650
- Startjog
  651
- Waitmotionend
  652
- Zygoadcdiagnosticstatusget
  653
- Zygoamplitudeget
  654
- Zygoconnecttoserver
  655
- Zygodisconnectfromserver
  656
- Zygoerrorstatusget
  657
- Zygoerrorstatusstringget
  658
- Zygoethernetcommunicationstatusget
  659
- Zygogetpeglastcommunicationtime
  660
- Zygogetverinterfero
  661
- Zygointerferometerstatusget
  662
- Zygopositionget
  663
- Zygoreadlong
  664
- Zygoreadword
  665
- Zygoregisterget
  666
- Zygoregisterset
  667
- Zygoreset
  668
- Zygoresetx
  669
- Zygoresety
  670
- Zygosendandreceive
  672
- Zygosetoffsetx
  673
- Zygosetoffsety
  674
- Zygosetpegparams
  675
- Zygostartboardp2
  677
- Zygostartinterferometer
  679
- Zygostatusget
  680
- Zygostatusstringget
  681
- Zygowritelong
  682
- Zygowriteword
  683
8 Lists and Tables for XPS Functions

684
- Event Triggers List
  684
- Actions List
  686
- Gathering Data Types
  687
- External Gathering Data Types
  689
- Positioner Error List
  690
- Positioner Hardware Status List
  691
- Positioner Driver Status List
  693
- Group Status List
  694
- Error List
  697
- Controller Status List
  701
9 Process Examples

702
- Management of Errors Example
  702
- Firmware Version Example
  703
- Gathering with Motion Example
  704
- External Gathering Example
  706
- Position Output Compare Example
  708
- Slave-Master Mode Example
  710
- Jogging Example
  712
- Tracking Example
  714
- Backlash
  715
- Timer Event and Global Variables
  717
- Running Several Motion Processes Simultaneously
  719
Service Form

721

Advertisement

Advertisement

Related Products

Newport Categories

Controller Measuring Instruments Receiver Industrial Equipment Temperature Controller

More Newport Manuals