Newport AG-UC2 Motor Controller User Manual
- June 8, 2024
- NEWPORT
Table of Contents
Newport AG-UC2 Motor Controller User Manual
Introduction
Purpose
The purpose of this document is to describe the application programming
interface (API) of the command library (AgilisCmdLib.dll) that is used to
communicate with the AGILIS UC2 or AGILIS-UC8 device.
Overview
The command library provides public methods to communicate with any AGILIS-UC2
or AGILIS-UC8 device and these methods work in both synchronous and
asynchronous mode. Many of the ASCII commands that can be programmatically
sent to the instrument have a corresponding method that can be called in the
command library. For example, the ASCII “VE” command can be sent to the
instrument to get the controller version, and the command library has a
corresponding public method “VE” that returns the controller version and error
information. For more information on a particular ASCII command see the manual
for the controller.
Command Interface
Constructor
AgilisCmds ()
The constructor is used to create an instance of the command library.
Functions
General
OpenInstrument
Syntax
int OpenInstrument(string strDeviceKey) string strDeviceKey: the device key is
a serial COM port return: 0 = successful or -1 = failure
Decription
This function allows opening communication with the selected device. If the
opening failed, the returned code is -1.
CloseInstrument
Syntax
int CloseInstrument() return: 0 = successful or -1 = failure
Decription
This function allows closing communication with the selected device. If the
closing failed, the returned code is -1.
GetDevices
Syntax
string[] GetDevices() return: list of strings that contains the accessible COM
ports.
Decription
This function returns the list of connected devices available to communicate
WriteToInstrument
Syntax
int WriteToInstrument(string command, ref string resp, int stage)
command: Instrument command
resp: Response of the command
stage: Instrument Stage
return: function error
Decription
This overridden function Queries or writes the command given by the user to
the instrument.
Commands
CC_Get
Syntax
int CC_Get(out int ChannelNumber, out string errstring)
ChannelNumber: ChannelNumber
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous CC Get command which is used to
Select channel (AGILIS-UC8 only). Refer to the AG-UC2-UC8 User’s manual to get
the command description.
Syntax
int CC_Set(int ChannelNumber, out string errstring)
ChannelNumber: ChannelNumber
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous CC Set command which is used to
Select channel (AGILIS-UC8 only). Refer to the AG-UC2-UC8 User’s manual to get
the command description.
JA_Get
Syntax
int JA_Get(int controllerAddress, out int JogMode, out string errstring)
controllerAddress: controllerAddress
JogMode: JogMode
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous JA Get command which is used to
Jog motion. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
JA_Set
Syntax
int JA_Set(int controllerAddress, int JogMode, out string errstring)
controllerAddress: controllerAddress
JogMode: JogMode
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous JA Set command which is used to
Jog motion. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
MA
Syntax
int MA(int controllerAddress, out int Distance, out string errstring)
controllerAddress: controllerAddress
Distance: Distance
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous MA Get command which is used to Measure current position. Refer to the AGUC2 UC8 User’s manual to get the command description
ML
Syntax
int ML(out string errstring)
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous ML Set command which is used to
Local mode. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
MR
Syntax
int MR(out string errstring)
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous MR Set command which is used to
Remote mode. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
MV_Get
Syntax
int MV_Get(int controllerAddress, out int JogMode, out string errstring)
controllerAddress: controllerAddress
JogMode: JogMode
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous MV Get command which is used to
Move to limit. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
MV_Set
Syntax
int MV_Set(int controllerAddress, int JogMode, out string errstring)
controllerAddress: controllerAddress
JogMode: JogMode
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous MV Set command which is used to
Move to limit. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
PA_Get
Syntax
int PA_Get(int controllerAddress, out int Target, out string errstring)
controllerAddress: controllerAddress
Target: Target
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PA Get command which is used to
Absolute move. Refer to the AG-UC2-UC8 User’s manual to get the command
description
PA_Set
Syntax
int PA_Set(int controllerAddress, int Target, out string errstring)
controllerAddress: controllerAddress
Target: Target
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PA Set command which is used to
Absolute move. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
PH
Syntax
int PH(out int LimitStatus, out string errstring)
LimitStatus: LimitStatus
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PH Get command which is used to
Tell limit status. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
PR
Syntax
int PR(int controllerAddress, long NumberSteps, out string errstring)
controllerAddress: controllerAddress
NumberSteps: NumberSteps
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PR Set command which is used to
Relative move. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
RS
Syntax
int RS(out string errstring)
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous RS Set command which is used to
Reset. Refer to the AG-UC2-UC8 User’s manual to get the command description.
ST
Syntax
int ST(int controllerAddress, out string errstring)
controllerAddress: controllerAddress
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous ST Set command which is used to
Stop motion. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
SU_Get
Syntax
int SU_Get(int controllerAddress, string Direction, out int StepAmplitude, out
string errstring)
controllerAddress: controllerAddress
Direction: Direction
StepAmplitude: StepAmplitude
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SU Get command which is used to
Set step amplitude. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
SU_Set
Syntax
int SU_Set(int controllerAddress, string Direction, int StepAmplitude, out
string errstring)
controllerAddress: controllerAddress
Direction: Direction
StepAmplitude: StepAmplitude
errString: The failure reason
Description
This function is used to process synchrounous SU Set command which is used to
Set step amplitude. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
TE
Syntax
int TE(out int ErrorPreviousCommand, out string errstring)
ErrorPreviousCommand: ErrorPreviousCommand
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous TE Get command which is used to
Get error of previous command. Refer to the AG-UC2-UC8 User’s manual to get
the command description.
TP
Syntax
int TP(int controllerAddress, out int NumberSteps, out string errstring)
controllerAddress: controllerAddress
NumberSteps: NumberSteps
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous TP Get command which is used to
Tell number of steps. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
TS
Syntax
int TS(int controllerAddress, out int AxisStatus, out string errstring)
controllerAddress: controllerAddress
AxisStatus: AxisStatus
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous TS Get command which is used to
Get axis status. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
VE
Syntax
int VE(out string ControllerVersion, out string errstring)
ControllerVersion: ControllerVersion
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous VE Get command which is used to
Firmware version. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
ZP
Syntax
int ZP(int controllerAddress, out string errstring)
controllerAddress: controllerAddress
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous ZP Set command which is used to
Zero position. Refer to the AG-UC2-UC8 User’s manual to get the command
description.
Service Form
Your Local Representative
Tel.:……………..
Fax:……………..
Name:…………………..
Return authorization #: ………………………..
Company:………………………………
(Please obtain prior to return of item)
Address……………….
Date:……………….
Country:…………………
Phone Number:……………..
P.O. Number:……………….
Fax Number:………………….
Item(s) Being Returned:……………
Model#:……………….
Serial #………………..
Description……………………..
Reasons of return of goods (please list any specific problems): ……….
Visit Newport Online at:
www.newport.com
North America & Asia
Newport Corporation 1791 Deere Ave. Irvine, CA 92606, USA
Sales
Tel.: 800-222-6440
e-mail: [email protected]
Technical Support
e-mail: [email protected]
Service, RMAs & Returns
Tel.: 800-222-6440
e-mail: [email protected]
Europe
MICRO-CONTROLE Spectra-Physics S.A.S 1, rue Jules Guesde – Bât. B ZI Bois de
l’Épine – BP189 91006 Evry Cedex France
Sales
Tel.: +33 (0)1.60.91.68.68
e-mail: [email protected]
Technical Support
e-mail: [email protected]
Service & Returns
Tel.: +33 (0)2.38.40.51.55
References
- Intellectual Property Law Firm | IP Attorneys | Fish & Richardson
- Newport - Photonics Solutions for Extending the Frontiers of Science