Related Manuals for Newport SMC100CC
Summary of Contents for Newport SMC100CC
- Page 1 SMC100CC & SMC100PP Single-Axix Motion Controller/Driver for DC or Stepper Motor Command Interface Manual V1.0.x...
- Page 2 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.
-
Page 3: Table Of Contents
Command Interface Manual Table of Contents 1.0 Introduction ....................1 Purpose........................1 Overview ........................1 Location ........................2 Possible uses of Newport.SMC100.CommandInterface.dll ........2 2.0 Command Interface ..................3 Constructor ........................3 Functions ........................3 2.2.1 General ......................... 3 2.2.1.1 OpenInstrument .................. - Page 4 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...
- Page 5 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...
- Page 6 SMC100CC & SMC100PP Command Interface Manual EDH0311En1021 – 09/18...
-
Page 7: Introduction
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. Overview Typically this DLL exposes all the commands the instrument supports. -
Page 8: Location
Newport.SMC100.CommandInterface.dll is located at Program Installation Directory\Newport\MotionControl\SMC100\Bin 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. -
Page 9: Command Interface
SMC100CC & SMC100PP Command Interface Manual Command Interface Constructor SMC100() The constructor is used to create an instance of the SMC100 device. 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... -
Page 10: Commands
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. -
Page 11: Ba_Set
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. -
Page 12: Dv_Get
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. -
Page 13: Fe_Get
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. -
Page 14: Frm_Get
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. -
Page 15: Frs_Set
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. -
Page 16: Id_Get
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. -
Page 17: Jm_Set
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. -
Page 18: Kd_Set
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. -
Page 19: Kp_Get
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. -
Page 20: Mm_Get
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. -
Page 21: Oh_Set
SMC100CC & SMC100PP Command Interface Manual 2.2.2.39 OH_Set Syntax int OH_Set(int controllerAddress, 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 Set command which is used to Set HOME search velocity. -
Page 22: Ot_Set
SMC100CC & SMC100PP Command Interface Manual 2.2.2.42 OT_Set Syntax int OT_Set(int controllerAddress, double HomeTimeOut, out string errstring) controllerAddress: controllerAddress HomeTimeOut: HomeTimeOut errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous OT Set command which is used to Set HOME search time-out. -
Page 23: Pr_Set
SMC100CC & SMC100PP Command Interface Manual 2.2.2.46 PR_Set Syntax int PR_Set(int controllerAddress, double Step, out string errstring) controllerAddress: controllerAddress Step: Step errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous PR Set command which is used to Move relative. -
Page 24: Pw_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.49 PW_Get Syntax int PW_Get(int controllerAddress, out int ConfigurationMode, out string errstring) controllerAddress: controllerAddress ConfigurationMode: ConfigurationMode errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous PW Get command which is used to Enter/Leave CONFIGURATION state. -
Page 25: Qil_Set
SMC100CC & SMC100PP Command Interface Manual 2.2.2.52 QIL_Set Syntax int QIL_Set(int controllerAddress, double MotorPeakCurrentLimits, out string errstring) controllerAddress: controllerAddress MotorPeakCurrentLimits: MotorPeakCurrentLimits errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous QIL Set command which is used to Set motor’s peak current limits. -
Page 26: Qit_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.55 QIT_Get Syntax int QIT_Get(int controllerAddress, out double MotorMsCurrentAveragingTime, out string errstring) controllerAddress: controllerAddress MotorMsCurrentAveragingTime: MotorMsCurrentAveragingTime errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous QIT Get command which is used to Get motor’s ms current averaging time. -
Page 27: Sa_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.58 RB Syntax int RB(int controllerAddress, out int TTLInputValue, out string errstring) controllerAddress: controllerAddress TTLInputValue: TTLInputValue errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous RB Get command which is used to Get TTL input value. -
Page 28: Sb_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.62 SB_Get Syntax int SB_Get(int controllerAddress, out int TTLOutputValue, out string errstring) controllerAddress: controllerAddress TTLOutputValue: TTLOutputValue errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous SB Get command which is used to Get TTL output value. -
Page 29: Sl_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.66 SE Syntax int SE(int controllerAddress, double TargetPosition, out string errstring) controllerAddress: controllerAddress TargetPosition: TargetPosition errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous SE Set command which is used to Configure/Execute simultaneous started move. -
Page 30: Sr_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.69 SR_Get Syntax int SR_Get(int controllerAddress, out double RightLimit, out string errstring) controllerAddress: controllerAddress RightLimit: RightLimit errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous SR Get command which is used to Get positive software limit. -
Page 31: Su_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.72 SU_Get Syntax int SU_Get(int controllerAddress, out double EncoderIncrement, out string errstring) controllerAddress: controllerAddress EncoderIncrement: EncoderIncrement errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous SU Get command which is used to Get encoder increment value. - Page 32 SMC100CC & SMC100PP Command Interface Manual 2.2.2.75 TE Syntax int TE(int controllerAddress, out string LastCommandError, out string errstring) controllerAddress: controllerAddress LastCommandError: LastCommandError errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous TE Get command which is used to Get last command error.
-
Page 33: Va_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.78 TS Syntax int TS(int controllerAddress, out string ErrorCode, out string StatusCode, out string errstring) controllerAddress: controllerAddress ErrorCode: ErrorCode StatusCode: StatusCode errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous TS Get command which is used to Get positioner error and controller state. -
Page 34: Vb_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.81 VB_Get Syntax int VB_Get(int controllerAddress, out double BaseVelocity, out string errstring) controllerAddress: controllerAddress BaseVelocity: BaseVelocity errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous VB Get command which is used to Get base velocity. -
Page 35: Zx_Get
SMC100CC & SMC100PP Command Interface Manual 2.2.2.85 ZX_Get Syntax int ZX_Get(int controllerAddress, out int Mode, out string errstring) controllerAddress: controllerAddress Mode: Mode errString: The failure reason return: 0 in success and -1 on failure Description This function is used to process synchronous ZX Get command which is used to Get ESP stage configuration. -
Page 36: Python Example
#The user should copy this code as is and specify correct paths here. import sys #Command Interface DLL can be found here. print "Adding location of Newport.SMC100.CommandInterface.dll to sys.path" sys.path.append(r'C:\Program Files\Newport\MotionControl\SMC100\Bin) # The CLR module provide functions for interacting with the underlying # .NET runtime... - Page 37 SMC100CC & SMC100PP Command Interface Manual # Get current position result, response, errString = SMC.TP(1) if result == 0 : print 'position=>', response else: print 'Error=>',errString # Unregister device SMC.UnregisterComponent(); EDH0311En1021 – 09/18...
- Page 38 SMC100CC & SMC100PP Command Interface Manual EDH0311En1021 – 09/18...
-
Page 39: Service Form
SMC100CC & SMC100PP Command Interface Manual Service Form Your Local Representative Tel.: __________________ Fax: ___________________ Name: _________________________________________________ Return authorization #: ____________________________________ (Please obtain prior to return of item) Company:_______________________________________________ Address: ________________________________________________ Date: __________________________________________________ Country: ________________________________________________ Phone Number: __________________________________________ P.O. Number: ____________________________________________... - Page 40 Visit Newport Online at: www.newport.com North America & Asia Europe Newport Corporation MICRO-CONTROLE Spectra-Physics S.A.S 1791 Deere Ave. 9, rue du Bois Sauvage Irvine, CA 92606, USA 91055 Évry CEDEX France Sales Tel.: (800) 222-6440 Sales e-mail: sales@newport.com Tel.: +33 (0)1.60.91.68.68 Technical Support e-mail: france@newport.com...