Newport SMC100CC User manual

SMC100CC & SMC100PP
Single-Axix Motion Controller/Driver
for DC or Stepper Motor
Command Interface
Manual
V1
.0.x

SMC100CC & SMC100PP Command Interface Manual
©2018by Newport Corporation, Irvine, CA. All rights reserved.
Original instructions.
No part of this document may be reproduced or copied without the prior written
approval of Newport Corporation. This document is provided for information only, and
product specifications are subject to change without notice. Any change will be
reflected in future publishings.
EDH0311En1021 – 09/18 ii

SMC100CC & SMC100PP Command Interface Manual
Table of Contents
1.0 Introduction .................................................................................................. 1
1.1 Purpose........................................................................................................................1
1.2 Overview.....................................................................................................................1
1.3 Location ......................................................................................................................2
1.4 Possible uses of Newport.SMC100.CommandInterface.dll........................................2
2.0 Command Interface...................................................................................... 3
2.1 Constructor..................................................................................................................3
2.2 Functions.....................................................................................................................3
2.2.1 General.................................................................................................................3
2.2.1.1 OpenInstrument.......................................................................................... 3
2.2.1.2 CloseInstrument ......................................................................................... 3
2.2.1.3 GetDevices ................................................................................................. 3
2.2.1.4 WriteToInstrument ..................................................................................... 3
2.2.2 Commands ...........................................................................................................4
2.2.2.1 AC_Get ...................................................................................................... 4
2.2.2.2 AC_Set ....................................................................................................... 4
2.2.2.3 BA_Get ...................................................................................................... 4
2.2.2.4 BA_Set ....................................................................................................... 5
2.2.2.5 BH_Get ...................................................................................................... 5
2.2.2.6 BH_Set ....................................................................................................... 5
2.2.2.7 DV_Get ...................................................................................................... 6
2.2.2.8 DV_Set....................................................................................................... 6
2.2.2.9 FD_Get....................................................................................................... 6
2.2.2.10 FD_Set...................................................................................................... 6
2.2.2.11 FE_Get ..................................................................................................... 7
2.2.2.12 FE_Set...................................................................................................... 7
2.2.2.13 FF_Get...................................................................................................... 7
2.2.2.14 FF_Set ...................................................................................................... 7
2.2.2.15 FRM_Get.................................................................................................. 8
2.2.2.16 FRM_Set .................................................................................................. 8
2.2.2.17 FRS_Get................................................................................................... 8
2.2.2.18 FRS_Set.................................................................................................... 9
2.2.2.19 HT_Get..................................................................................................... 9
2.2.2.20 HT_Set ..................................................................................................... 9
2.2.2.21 ID_Get.....................................................................................................10
2.2.2.22 ID_Set .....................................................................................................10
2.2.2.23 JD ............................................................................................................10
iii EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2.24 JM_Get....................................................................................................10
2.2.2.25 JM_Set.....................................................................................................11
2.2.2.26 JR_Get.....................................................................................................11
2.2.2.27 JR_Set .....................................................................................................11
2.2.2.28 KD_Get ...................................................................................................11
2.2.2.29 KD_Set....................................................................................................12
2.2.2.30 KI_Get.....................................................................................................12
2.2.2.31 KI_Set .....................................................................................................12
2.2.2.32 KP_Get....................................................................................................13
2.2.2.33 KP_Set.....................................................................................................13
2.2.2.34 KV_Get ...................................................................................................13
2.2.2.35 KV_Set....................................................................................................13
2.2.2.36 MM_Get..................................................................................................14
2.2.2.37 MM_Set...................................................................................................14
2.2.2.38 OH_Get ...................................................................................................14
2.2.2.39 OH_Set....................................................................................................15
2.2.2.40 OR ...........................................................................................................15
2.2.2.41 OT_Get....................................................................................................15
2.2.2.42 OT_Set ....................................................................................................16
2.2.2.43 PA_Get....................................................................................................16
2.2.2.44 PA_Set.....................................................................................................16
2.2.2.45 PR_Get ....................................................................................................16
2.2.2.46 PR_Set.....................................................................................................17
2.2.2.47 PT_Get ....................................................................................................17
2.2.2.48 PT_Set.....................................................................................................17
2.2.2.49 PW_Get...................................................................................................18
2.2.2.50 PW_Set....................................................................................................18
2.2.2.51 QIL_Get ..................................................................................................18
2.2.2.52 QIL_Set ...................................................................................................19
2.2.2.53 QIR_Get ..................................................................................................19
2.2.2.54 QIR_Set...................................................................................................19
2.2.2.55 QIT_Get ..................................................................................................20
2.2.2.56 QIT_Set...................................................................................................20
2.2.2.57 RA ...........................................................................................................20
2.2.2.58 RB ...........................................................................................................21
2.2.2.59 RS............................................................................................................21
2.2.2.60 SA_Get....................................................................................................21
2.2.2.61 SA_Set.....................................................................................................21
2.2.2.62 SB_Get ....................................................................................................22
2.2.2.63 SB_Set.....................................................................................................22
2.2.2.64 SC_Get ....................................................................................................22
2.2.2.65 SC_Set.....................................................................................................22
2.2.2.66 SE ............................................................................................................23
2.2.2.67 SL_Get ....................................................................................................23
EDH0311En1021 – 09/18 iv

SMC100CC & SMC100PP Command Interface Manual
2.2.2.68 SL_Set .....................................................................................................23
2.2.2.69 SR_Get ....................................................................................................24
2.2.2.70 SR_Set.....................................................................................................24
2.2.2.71 ST ............................................................................................................24
2.2.2.72 SU_Get....................................................................................................25
2.2.2.73 SU_Set.....................................................................................................25
2.2.2.74 TB............................................................................................................25
2.2.2.75 TE............................................................................................................26
2.2.2.76 TH ...........................................................................................................26
2.2.2.77 TP............................................................................................................26
2.2.2.78 TS............................................................................................................27
2.2.2.79 VA_Get ...................................................................................................27
2.2.2.80 VA_Set....................................................................................................27
2.2.2.81 VB_Get ...................................................................................................28
2.2.2.82 VB_Set ....................................................................................................28
2.2.2.83 VE ...........................................................................................................28
2.2.2.84 ZT............................................................................................................28
2.2.2.85 ZX_Get....................................................................................................29
2.2.2.86 ZX_Set ....................................................................................................29
3.0 Python example........................................................................................... 30
Service Form ........................................................................................................ 33
v EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
EDH0311En1021 – 09/18 vi

SMC100CC & SMC100PP Command Interface Manual
1.0 Introduction
1.1 Purpose
The purpose of this document is to provide the method syntax of each
command to communicate with the SMC100 device exposed in assembly
Newport.SMC100.CommandInterface.dll. This .Net assembly is
designed and developed by Newport. This DLL is used by SMC100
applet to communicate with SMC100 instrument.
1.2 Overview
Typically this DLL exposes all the commands the instrument supports.
These commands are exposed as function calls of the Command Interface
DLL.
Newport.SMC100.CommandInterface.dll is the assembly used for
communicating with SMC100 instrument. This assembly gets installed
when SMC100 applet is installed.
NOTE
Each function name is defined with the command code “AA”.
For each command function, refer to the SMC100 programmer’s manual.
Single
-Axis Motion
Controller/Driver
SMC100CC & SMC100PP
1 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
1.3 Location
Newport.SMC100.CommandInterface.dll is located at
Program Installation Directory\Newport\MotionControl\SMC100\Bin
1.4 Possible uses of Newport.SMC100.CommandInterface.dll
Newport.SMC100.CommandInterface.dll is used by SMC100 applet for
communicating with SMC100 instrument. The same DLL can be used as
a reusable software component for creating Python script or for creating
LabVIEW VIs.
EDH0311En1021 – 09/18 2

SMC100CC & SMC100PP Command Interface Manual
2.0 Command Interface
2.1 Constructor
SMC100()
The constructor is used to create an instance of the SMC100 device.
2.2 Functions
2.2.1 General
2.2.1.1 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.
2.2.1.2 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.
2.2.1.3 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.
2.2.1.4 WriteToInstrument
Syntax
int WriteToInstrument(string command, ref string response, int stage)
command: Instrument command
response: Response of the command
stage: Instrument Stage
return:
Decription
This Overridden function Queries or writes the command given by the user to the
instrument.
3 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2 Commands
2.2.2.1 AC_Get
Syntax
int AC_Get(int controllerAddress, out double Acceleration, out string errstring)
controllerAddress: controllerAddress
Acceleration: Acceleration
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous AC Get command which is used to Get
acceleration. Refer to the Controller's manual to get the command description.
2.2.2.2 AC_Set
Syntax
int AC_Set(int controllerAddress, double Acceleration, out string errstring)
controllerAddress: controllerAddress
Acceleration: Acceleration
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous AC Set command which is used to Set
acceleration. Refer to the Controller's manual to get the command description.
2.2.2.3 BA_Get
Syntax
int BA_Get(int controllerAddress, out double Backlash, out string errstring)
controllerAddress: controllerAddress
Backlash: Backlash
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous BA Get command which is used to Get
backlash compensation. Refer to the Controller's manual to get the command
description.
EDH0311En1021 – 09/18 4

SMC100CC & SMC100PP Command Interface Manual
2.2.2.4 BA_Set
Syntax
int BA_Set(int controllerAddress, double Backlash, out string errstring)
controllerAddress: controllerAddress
Backlash: Backlash
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous BA Set command which is used to Set
backlash compensation. Refer to the Controller's manual to get the command
description.
2.2.2.5 BH_Get
Syntax
int BH_Get(int controllerAddress, out double Hysteresis, out string errstring)
controllerAddress: controllerAddress
Hysteresis: Hysteresis
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous BH Get command which is used to Get
hysteresis compensation. Refer to the Controller's manual to get the command
description.
2.2.2.6 BH_Set
Syntax
int BH_Set(int controllerAddress, double Hysteresis, out string errstring)
controllerAddress: controllerAddress
Hysteresis: Hysteresis
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous BH Set command which is used to Set
hysteresis compensation. Refer to the Controller's manual to get the command
description.
5 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2.7 DV_Get
Syntax
int DV_Get(int controllerAddress, out double Voltage, out string errstring)
controllerAddress: controllerAddress
Voltage: Voltage
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous DV Get command which is used to Get
driver voltage. Refer to the Controller's manual to get the command description.
2.2.2.8 DV_Set
Syntax
int DV_Set(int controllerAddress, double Voltage, out string errstring)
controllerAddress: controllerAddress
Voltage: Voltage
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous DV Set command which is used to Set
driver voltage. Refer to the Controller's manual to get the command description.
2.2.2.9 FD_Get
Syntax
int FD_Get(int controllerAddress, out double LowPassFilter, out string errstring)
controllerAddress: controllerAddress
LowPassFilter: LowPassFilter
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FD Get command which is used to Get
low pass filter for Kd. Refer to the Controller's manual to get the command description.
2.2.2.10 FD_Set
Syntax
int FD_Set(int controllerAddress, double LowPassFilter, out string errstring)
controllerAddress: controllerAddress
LowPassFilter: LowPassFilter
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FD Set command which is used to Set low
pass filter for Kd. Refer to the Controller's manual to get the command description.
EDH0311En1021 – 09/18 6

SMC100CC & SMC100PP Command Interface Manual
2.2.2.11 FE_Get
Syntax
int FE_Get(int controllerAddress, out double FollowingError, out string errstring)
controllerAddress: controllerAddress
FollowingError: FollowingError
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FE Get command which is used to Get
following error limit. Refer to the Controller's manual to get the command description.
2.2.2.12 FE_Set
Syntax
int FE_Set(int controllerAddress, double FollowingError, out string errstring)
controllerAddress: controllerAddress
FollowingError: FollowingError
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FE Set command which is used to Set
following error limit. Refer to the Controller's manual to get the command description.
2.2.2.13 FF_Get
Syntax
int FF_Get(int controllerAddress, out double FrictionCompensation, out string errstring)
controllerAddress: controllerAddress
FrictionCompensation: FrictionCompensation
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FF Get command which is used to Get
friction compensation. Refer to the Controller's manual to get the command description.
2.2.2.14 FF_Set
Syntax
int FF_Set(int controllerAddress, double FrictionCompensation, out string errstring)
controllerAddress: controllerAddress
FrictionCompensation: FrictionCompensation
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FF Set command which is used to Set
friction compensation. Refer to the Controller's manual to get the command description.
7 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2.15 FRM_Get
Syntax
int FRM_Get(int controllerAddress, out int MicroStepPerFullStepFactor, out string
errstring)
controllerAddress: controllerAddress
MicroStepPerFullStepFactor: MicroStepPerFullStepFactor
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FRM Get command which is used to Get
micro-step per full step factor for stepper motor. Refer to the Controller's manual to get
the command description.
2.2.2.16 FRM_Set
Syntax
int FRM_Set(int controllerAddress, int MicroStepPerFullStepFactor, out string
errstring)
controllerAddress: controllerAddress
MicroStepPerFullStepFactor: MicroStepPerFullStepFactor
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FRM Set command which is used to Set
micro-step per full step factor for stepper motor. Refer to the Controller's manual to get
the command description.
2.2.2.17 FRS_Get
Syntax
int FRS_Get(int controllerAddress, out double DistancePerMotorFullStep, out string
errstring)
controllerAddress: controllerAddress
DistancePerMotorFullStep: DistancePerMotorFullStep
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FRS Get command which is used to Get
the motion distance per motor's full step for stepper motor. Refer to the Controller's
manual to get the command description.
EDH0311En1021 – 09/18 8

SMC100CC & SMC100PP Command Interface Manual
2.2.2.18 FRS_Set
Syntax
int FRS_Set(int controllerAddress, double DistancePerMotorFullStep, out string
errstring)
controllerAddress: controllerAddress
DistancePerMotorFullStep: DistancePerMotorFullStep
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous FRS Set command which is used to Set the
motion distance per motor's full step for stepper motor. Refer to the Controller's manual
to get the command description.
2.2.2.19 HT_Get
Syntax
int HT_Get(int controllerAddress, out int HomeType, out string errstring)
controllerAddress: controllerAddress
HomeType: HomeType
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous HT Get command which is used to Get
HOME search type. Refer to the Controller's manual to get the command description.
2.2.2.20 HT_Set
Syntax
int HT_Set(int controllerAddress, int HomeType, out string errstring)
controllerAddress: controllerAddress
HomeType: HomeType
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous HT Set command which is used to Set
HOME search type. Refer to the Controller's manual to get the command description.
9 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2.21 ID_Get
Syntax
int ID_Get(int controllerAddress, out string StageIdentifier, out string errstring)
controllerAddress: controllerAddress
StageIdentifier: StageIdentifier
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous ID Get command which is used to Get
stage identifier. Refer to the Controller's manual to get the command description.
2.2.2.22 ID_Set
Syntax
int ID_Set(int controllerAddress, string StageIdentifier, out string errstring)
controllerAddress: controllerAddress
StageIdentifier: StageIdentifier
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous ID Set command which is used to Set
stage identifier. Refer to the Controller's manual to get the command description.
2.2.2.23 JD
Syntax
int JD(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 synchronous JD Set command which is used to Leave
JOGGING state. Refer to the Controller's manual to get the command description.
2.2.2.24 JM_Get
Syntax
int JM_Get(int controllerAddress, out int KeypadState, out string errstring)
controllerAddress: controllerAddress
KeypadState: KeypadState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous JM Get command which is used to
Enable/Disable Keypad. Refer to the Controller's manual to get the command
description.
EDH0311En1021 – 09/18 10

SMC100CC & SMC100PP Command Interface Manual
2.2.2.25 JM_Set
Syntax
int JM_Set(int controllerAddress, int KeypadState, out string errstring)
controllerAddress: controllerAddress
KeypadState: KeypadState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous JM Set command which is used to
Enable/Disable Keypad. Refer to the Controller's manual to get the command
description.
2.2.2.26 JR_Get
Syntax
int JR_Get(int controllerAddress, out double JerkTime, out string errstring)
controllerAddress: controllerAddress
JerkTime: JerkTime
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous JR Get command which is used to Get jerk
time. Refer to the Controller's manual to get the command description.
2.2.2.27 JR_Set
Syntax
int JR_Set(int controllerAddress, double JerkTime, out string errstring)
controllerAddress: controllerAddress
JerkTime: JerkTime
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous JR Set command which is used to Set jerk
time. Refer to the Controller's manual to get the command description.
2.2.2.28 KD_Get
Syntax
int KD_Get(int controllerAddress, out double DerivativeGain, out string errstring)
controllerAddress: controllerAddress
DerivativeGain: DerivativeGain
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KD Get command which is used to Get
derivative gain. Refer to the Controller's manual to get the command description.
11 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2.29 KD_Set
Syntax
int KD_Set(int controllerAddress, double DerivativeGain, out string errstring)
controllerAddress: controllerAddress
DerivativeGain: DerivativeGain
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KD Set command which is used to Set
derivative gain. Refer to the Controller's manual to get the command description.
2.2.2.30 KI_Get
Syntax
int KI_Get(int controllerAddress, out double IntegralGain, out string errstring)
controllerAddress: controllerAddress
IntegralGain: IntegralGain
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KI Get command which is used to Get
integral gain. Refer to the Controller's manual to get the command description.
2.2.2.31 KI_Set
Syntax
int KI_Set(int controllerAddress, double IntegralGain, out string errstring)
controllerAddress: controllerAddress
IntegralGain: IntegralGain
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KI Set command which is used to Set
integral gain. Refer to the Controller's manual to get the command description.
EDH0311En1021 – 09/18 12

SMC100CC & SMC100PP Command Interface Manual
2.2.2.32 KP_Get
Syntax
int KP_Get(int controllerAddress, out double ProportionalGain, out string errstring)
controllerAddress: controllerAddress
ProportionalGain: ProportionalGain
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KP Get command which is used to Get
proportional gain. Refer to the Controller's manual to get the command description.
2.2.2.33 KP_Set
Syntax
int KP_Set(int controllerAddress, double ProportionalGain, out string errstring)
controllerAddress: controllerAddress
ProportionalGain: ProportionalGain
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KP Set command which is used to Set
proportional gain. Refer to the Controller's manual to get the command description.
2.2.2.34 KV_Get
Syntax
int KV_Get(int controllerAddress, out double VelocityFeedForward, out string
errstring)
controllerAddress: controllerAddress
VelocityFeedForward: VelocityFeedForward
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KV Get command which is used to Get
velocity feed forward. Refer to the Controller's manual to get the command description.
2.2.2.35 KV_Set
Syntax
int KV_Set(int controllerAddress, double VelocityFeedForward, out string errstring)
controllerAddress: controllerAddress
VelocityFeedForward: VelocityFeedForward
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous KV Set command which is used to Set
velocity feed forward. Refer to the Controller's manual to get the command description.
13 EDH0311En1021 – 09/18

SMC100CC & SMC100PP Command Interface Manual
2.2.2.36 MM_Get
Syntax
int MM_Get(int controllerAddress, out string DisableState, out string errstring)
controllerAddress: controllerAddress
DisableState: DisableState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous MM Get command which is used to
Enter/Leave DISABLE state. Refer to the Controller's manual to get the command
description.
2.2.2.37 MM_Set
Syntax
int MM_Set(int controllerAddress, int DisableState, out string errstring)
controllerAddress: controllerAddress
DisableState: DisableState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous MM Set command which is used to
Enter/Leave DISABLE state. Refer to the Controller's manual to get the command
description.
2.2.2.38 OH_Get
Syntax
int OH_Get(int controllerAddress, out double HomeVelocity, out string errstring)
controllerAddress: controllerAddress
HomeVelocity: HomeVelocity
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchronous OH Get command which is used to Get
HOME search velocity. Refer to the Controller's manual to get the command
description.
EDH0311En1021 – 09/18 14