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.
C:\Program Files (x86)\Newport\MotionControl\HXP\Bin\Newport.HXP.CommandInterface.dll Possible Uses of Newport. HXP.CommandInterface.dll Newport. HXP.CommandInterface.dll is used by HXP applet for communicating with HXP instrument. The same DLL can be used as a reusable software component for creating Python script or for creating LabVIEW VIs.
Command Interface Manual Command Interface Constructor Syntax HXP() Decription The constructor is used to create an instance of the HXP device. Functions 2.2.1 OpenInstrument Syntax C# prototype int OpenInstrument (string Address, int port) Python prototype [Return] OpenInstrument (Address, Port) Parameter Input parameters None Output parameters...
Command Interface Manual Output parameters None Return (int) error code: 0 in success and -1 on failure Description This function is used to close the communication with the controller. The current socket is deleted and the TCP IP connection is closed. Refer to HXP Programmer’s manual to get the command description.
Command Interface Manual Parameters Input parameters None Output parameters (double) ElapsedTime: ElapsedTime (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous ElapsedTimeGet command which is used to Return elapsed time from controller power on.
Command Interface Manual Output parameters (string) Version: Version (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous FirmwareVersionGet command which is used to Return firmware version. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Parameters Input parameters (string) TCLFileName: TCLFileName (string) TaskName: TaskName (string) InputParametersList: InputParametersList Output parameters (string) OutputParametersList: OutputParametersList (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous TCLScriptExecuteAndWait command which is used to Execute a TCL script from a TCL file and wait the end of execution to return.
Command Interface Manual Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous TCLScriptKillAll command which is used to Kill all TCL Tasks. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous TimerSet command which is used to Set a timer. Refer to the XPS Programmer's manual to get the command description. 2.2.13 Reboot Syntax...
Command Interface Manual Description This function is used to process synchrounous Login command which is used to Log in. Refer to the XPS Programmer's manual to get the command description. 2.2.15 CloseAllOtherSockets Syntax C# prototype int CloseAllOtherSockets( out string errstring) Python prototype [errstring] CloseAllOtherSockets () Parameters...
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EventAdd command which is used to ** OBSOLETE ** Add an event. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EventRemove command which is used to ** OBSOLETE ** Delete an event. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Parameters Input parameters (string[]) ExtendedEventName: ExtendedEventName (string[]) EventParameter1: EventParameter1 (string[]) EventParameter2: EventParameter2 (string[]) EventParameter3: EventParameter3 (string[]) EventParameter4: EventParameter4 Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EventExtendedConfigurationTriggerSet command which is used to Configure one or several events.
Command Interface Manual Python prototype [errstring] EventExtendedConfigurationActionSet (ExtendedActionName, ActionParameter1, ActionParameter2, ActionParameter3, ActionParameter4) Parameters Input parameters (string[]) ExtendedActionName: ExtendedActionName (string[]) ActionParameter1: ActionParameter1 (string[]) ActionParameter2: ActionParameter2 (string[]) ActionParameter3: ActionParameter3 (string[]) ActionParameter4: ActionParameter4 Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EventExtendedConfigurationActionSet command which is used to Configure one or several actions.
Command Interface Manual 2.2.24 EventExtendedStart Syntax C# prototype int EventExtendedStart(out Int32 ID, out string errstring) Python prototype [ID, errstring] EventExtendedStart () Parameters Input parameters None Output parameters (Int32_i) ID: ID (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EventExtendedStart command which is used to Launch the last event and action configuration and return an ID.
Command Interface Manual 2.2.28 EventExtendedWait Syntax C# prototype int EventExtendedWait( out string errstring) Python prototype [errstring] EventExtendedWait () Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EventExtendedWait command which is used to Wait events from the last event configuration.
Command Interface Manual 2.2.30 GatheringConfigurationSet Syntax C# prototype int GatheringConfigurationSet(string[] Type, out string errstring) Python prototype [errstring] GatheringConfigurationSet (Type) Parameters Input parameters (string[]) Type: Type Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringConfigurationSet command which is used to Configuration acquisition.
Command Interface Manual 2.2.32 GatheringStopAndSave Syntax C# prototype int GatheringStopAndSave( out string errstring) Python prototype [errstring] GatheringStopAndSave () Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringStopAndSave command which is used to Stop acquisition and save data.
Command Interface Manual 2.2.34 GatheringDataGet Syntax C# prototype int GatheringDataGet(Int32 IndexPoint, out string DataBufferLine, out string errstring) Python prototype [DataBufferLine, errstring] GatheringDataGet (IndexPoint) Parameters Input parameters (Int32) IndexPoint: IndexPoint Output parameters (string) DataBufferLine: DataBufferLine (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringDataGet command which is...
Command Interface Manual 2.2.36 GatheringReset Syntax C# prototype int GatheringReset( out string errstring) Python prototype [errstring] GatheringReset () Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringReset command which is used to Empty the gathered data in memory to start new gathering from scratch.
Command Interface Manual 2.2.38 GatheringStop Syntax C# prototype int GatheringStop( out string errstring) Python prototype [errstring] GatheringStop () Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringStop command which is used to Stop the data gathering .
Command Interface Manual 2.2.40 GatheringExternalConfigurationGet Syntax C# prototype int GatheringExternalConfigurationGet(out string Type, out string errstring) Python prototype [Type, errstring] GatheringExternalConfigurationGet () Parameters Input parameters None Output parameters (string) Type: Type (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringExternalConfigurationGet command which is used to Read different mnemonique type.
Command Interface Manual 2.2.42 GatheringExternalStopAndSave Syntax C# prototype int GatheringExternalStopAndSave( out string errstring) Python prototype [errstring] GatheringExternalStopAndSave () Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringExternalStopAndSave command which is used to Stop acquisition and save data.
Command Interface Manual 2.2.44 GlobalArraySet Syntax C# prototype int GlobalArraySet(Int32 Number, string ValueString, out string errstring) Python prototype [errstring] GlobalArraySet (Number, ValueString) Parameters Input parameters (Int32) Number: Number (string) ValueString: ValueString Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GlobalArraySet command which is used to Set global array value.
Command Interface Manual 2.2.46 DoubleGlobalArraySet Syntax C# prototype int DoubleGlobalArraySet(Int32 Number, double DoubleValue, out string errstring) Python prototype [errstring] DoubleGlobalArraySet (Number, DoubleValue) Parameters Input parameters (Int32) Number: Number (double) DoubleValue: DoubleValue Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous DoubleGlobalArraySet command which is used to Set double global array value.
Command Interface Manual 2.2.48 GPIOAnalogSet Syntax C# prototype int GPIOAnalogSet(string[] GPIOName, double[] AnalogOutputValue, out string errstring) Python prototype [errstring] GPIOAnalogSet (GPIOName, AnalogOutputValue) Parameters Input parameters (string[]) GPIOName: GPIOName (double[]) AnalogOutputValue: AnalogOutputValue Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GPIOAnalogSet command which is used to Set analog output for one or few output.
Command Interface Manual 2.2.50 GPIOAnalogGainSet Syntax C# prototype int GPIOAnalogGainSet(string[] GPIOName, Int32[] AnalogInputGainValue, out string errstring) Python prototype [errstring] GPIOAnalogGainSet (GPIOName, AnalogInputGainValue) Parameters Input parameters (string[]) GPIOName: GPIOName (Int32) AnalogInputGainValue: AnalogInputGainValue Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GPIOAnalogGainSet command which is used to Set analog input gain .
Command Interface Manual 2.2.54 GroupHomeSearch Syntax C# prototype int GroupHomeSearch(string GroupName, out string errstring) Python prototype [errstring] GroupHomeSearch (GroupName) Parameters Input parameters (string) GroupName: GroupName Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GroupHomeSearch command which is used to Start home search sequence.
Command Interface Manual Description This function is used to process synchrounous GroupInitialize command which is used to Start the initialization. Refer to the XPS Programmer's manual to get the command description. 2.2.58 GroupInitializeWithEncoderCalibration Syntax C# prototype int GroupInitializeWithEncoderCalibration(string GroupName, out string errstring) Python prototype [errstring] GroupInitializeWithEncoderCalibration (GroupName) Parameters...
Command Interface Manual 2.2.60 GroupMoveAbort Syntax C# prototype int GroupMoveAbort(string GroupName, out string errstring) Python prototype [errstring] GroupMoveAbort (GroupName) Parameters Input parameters (string) GroupName: GroupName Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GroupMoveAbort command which is used to Abort a move.
Command Interface Manual 2.2.64 GroupMotionEnable Syntax C# prototype int GroupMotionEnable(string GroupName, out string errstring) Python prototype [errstring] GroupMotionEnable (GroupName) Parameters Input parameters (string) GroupName: GroupName Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GroupMotionEnable command which is used to Set Motion enable on selected group.
Command Interface Manual Description This function is used to process synchrounous GroupReferencingActionExecute command which is used to Execute an action in referencing mode. Refer to the XPS Programmer's manual to get the command description. 2.2.70 GroupReferencingStart Syntax C# prototype int GroupReferencingStart(string GroupName, out string errstring) Python prototype [errstring] GroupReferencingStart (GroupName) Parameters...
Command Interface Manual 2.2.72 GroupStatusGet Syntax C# prototype int GroupStatusGet(string GroupName, out Int32 Status, out string errstring) Python prototype [Status, errstring] GroupStatusGet (GroupName) Parameters Input parameters (string) GroupName: GroupName Output parameters (Int32_i) Status: Status (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GroupStatusGet command which is used...
Command Interface Manual 2.2.74 KillAll Syntax C# prototype int KillAll( out string errstring) Python prototype [errstring] KillAll () Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous KillAll command which is used to Put all groups in 'Not initialized' state.
Command Interface Manual 2.2.78 PositionerBacklashEnable Syntax C# prototype int PositionerBacklashEnable(string PositionerName, out string errstring) Python prototype [errstring] PositionerBacklashEnable (PositionerName) Parameters Input parameters (string) PositionerName: PositionerName Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerBacklashEnable command which is used to Enable the backlash.
Command Interface Manual Output parameters (double) NotchFrequency1: NotchFrequency1 (double) NotchBandwith1: NotchBandwith1 (double) NotchGain1: NotchGain1 (double) NotchFrequency2: NotchFrequency2 (double) NotchBandwith2: NotchBandwith2 (double) NotchGain2: NotchGain2 (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerCorrectorNotchFiltersGet command which is used to Read filters parameters .
Command Interface Manual Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerCorrectorPIDFFAccelerationSet command which is used to Update corrector parameters. Refer to the XPS Programmer's manual to get the command description. 2.2.83 PositionerCorrectorPIDFFAccelerationGet Syntax...
Command Interface Manual Description This function is used to process synchrounous PositionerCorrectorPIDFFAccelerationGet command which is used to Read corrector parameters. Refer to the XPS Programmer's manual to get the command description. 2.2.84 PositionerCorrectorPIDFFVelocitySet Syntax C# prototype int PositionerCorrectorPIDFFVelocitySet(string PositionerName, bool ClosedLoopStatus, double KP, double KI, double KD, double KS, double IntegrationTime, double DerivativeFilterCutOffFrequency, double GKP, double GKI, double GKD, double KForm, double FeedForwardGainVelocity, out string errstring)
Command Interface Manual 2.2.85 PositionerCorrectorPIDFFVelocityGet Syntax C# prototype int PositionerCorrectorPIDFFVelocityGet(string PositionerName, out bool ClosedLoopStatus, out double KP, out double KI, out double KD, out double KS, out double IntegrationTime, out double DerivativeFilterCutOffFrequency, out double GKP, out double GKI, out double GKD, out double KForm, out double FeedForwardGainVelocity, out string errstring) Python prototype [ClosedLoopStatus, KP, KI, KD, KS, IntegrationTime,...
Command Interface Manual Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerCorrectorPIPositionSet command which is used to Update corrector parameters. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Parameters Input parameters (string) PositionerName: PositionerName Output parameters (string) CorrectorType: CorrectorType (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerCorrectorTypeGet command which is used to Read corrector type.
Command Interface Manual Python prototype [CurrentVelocityCutOffFrequency, CurrentAccelerationCutOffFrequency, errstring] PositionerCurrentVelocityAccelerationFiltersGet (PositionerName) Parameters Input parameters (string) PositionerName: PositionerName Output parameters (double) CurrentVelocityCutOffFrequency: CurrentVelocityCutOffFrequency (double) CurrentAccelerationCutOffFrequency: CurrentAccelerationCutOffFrequency (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerCurrentVelocityAccelerationFiltersGet command which is used to Get...
Command Interface Manual 2.2.94 PositionerDriverStatusStringGet Syntax C# prototype int PositionerDriverStatusStringGet(Int32 PositionerDriverStatus, out string PositionerDriverStatusString, out string errstring) Python prototype [PositionerDriverStatusString, errstring] PositionerDriverStatusStringGet (PositionerDriverStatus) Parameters Input parameters (Int32) PositionerDriverStatus: PositionerDriverStatus Output parameters (string) PositionerDriverStatusString: PositionerDriverStatusString (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerDriverStatusStringGet...
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerEncoderAmplitudeValuesGet command which is used to Read analog interpolated encoder amplitude values. Refer to the XPS Programmer's manual to get the command description. 2.2.96 PositionerEncoderCalibrationParametersGet Syntax...
Command Interface Manual Output parameters (Int32_i) ErrorCode: ErrorCode (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerErrorGet command which is used to Read and clear positioner error code. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Output parameters (string) PositionerErrorString: PositionerErrorString (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerErrorStringGet command which is used to Return the positioner status string corresponding to the positioner error code.
Command Interface Manual Output parameters (string) PositionerHardwareStatusString: PositionerHardwareStatusString (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerHardwareStatusStringGet command which is used to Return the positioner hardware status string corresponding to the positioner error code.
Command Interface Manual Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerHardInterpolatorFactorSet command which is used to Set hard interpolator parameters. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Parameters Input parameters (string) PositionerName: PositionerName Output parameters (double) PositionWindow: PositionWindow (double) VelocityWindow: VelocityWindow (double) CheckingTime: CheckingTime (double) MeanPeriod: MeanPeriod (double) TimeOut: TimeOut (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerMotionDoneGet command which is used to Read motion done parameters.
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerSGammaParametersGet command which is used to Read dynamic parameters for one axe of a group for a future displacement .
Command Interface Manual Parameters Input parameters (string) PositionerName: PositionerName (double) Displacement: Displacement (double) Velocity: Velocity (double) Acceleration: Acceleration (double) MinJerkTime: MinJerkTime (double) MaxJerkTime: MaxJerkTime Output parameters (double) DisplacementDuringAcc: DisplacementDuringAcc (double) DisplacementDuringVel: DisplacementDuringVel (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerSGammaParametersDistanceGet command which is used to Returns distance...
Command Interface Manual Description This function is used to process synchrounous PositionerStageParameterSet command which is used to Save the stage parameter. Refer to the XPS Programmer's manual to get the command description. 2.2.114 PositionerUserTravelLimitsGet Syntax C# prototype int PositionerUserTravelLimitsGet(string PositionerName, out double UserMinimumTarget, out double UserMaximumTarget, out string errstring) Python prototype [UserMinimumTarget, UserMaximumTarget, errstring] PositionerUserTravelLimitsGet...
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerUserTravelLimitsSet command which is used to Update UserMinimumTarget and UserMaximumTarget. Refer to the XPS Programmer's manual to get the command description. 2.2.116 HexapodMoveAbsolute Syntax C# prototype...
Command Interface Manual Parameters Input parameters (string) GroupName: GroupName (string) CoordinateSystem: CoordinateSystem (double) dX: dX (double) dY: dY (double) dZ: dZ (double) dU: dU (double) dV: dV (double) dW: dW Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HexapodMoveIncremental command which is used to Hexapod incremental move in a specific coordinate system.
Command Interface Manual Output parameters (double) Xout: Xout (double) Yout: Yout (double) Zout: Zout (double) Uout: Uout (double) Vout: Vout (double) Wout: Wout (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HexapodCoordinatesGet command which is used to Get coordinates in a specific coordinate system of a point specified in another coordinate system.
Command Interface Manual 2.2.120 HexapodCoordinateSystemGet Syntax C# prototype int HexapodCoordinateSystemGet(string GroupName, string CoordinateSystem, out double X, out double Y, out double Z, out double U, out double V, out double W, out string errstring) Python prototype [X, Y, Z, U, V, W, errstring] HexapodCoordinateSystemGet (GroupName, CoordinateSystem) Parameters Input parameters...
Command Interface Manual Parameters Input parameters (string) GroupName: GroupName (string) CoordinateSystem: CoordinateSystem (string) HexapodTrajectoryType: HexapodTrajectoryType (double) dX: dX (double) dY: dY (double) dZ: dZ Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HexapodMoveIncrementalControl command which is used to Hexapod trajectory .
Command Interface Manual Description This function is used to process synchrounous HexapodMoveIncrementalControlWithTargetVelocity command which is used to Hexapod trajectory . Refer to the XPS Programmer's manual to get the command description. 2.2.123 HexapodMoveIncrementalControlPulseAndGatheringSet Syntax C# prototype int HexapodMoveIncrementalControlPulseAndGatheringSet(string GroupName, Int32 Divisor, out string errstring) Python prototype [errstring] HexapodMoveIncrementalControlPulseAndGatheringSet (GroupName,...
Command Interface Manual Parameters Input parameters (string) GroupName: GroupName (string) CoordinateSystem: CoordinateSystem (string) HexapodTrajectoryType: HexapodTrajectoryType (double) dX: dX (double) dY: dY (double) dZ: dZ Output parameters (double) MaximumVelocityCarriage: MaximumVelocityCarriage (double) TrajectoryPercent: TrajectoryPercent (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HexapodMoveIncrementalControlLimitGet command which is used to Returns the...
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HexapodSGammaParametersDistanceGet command which is used to Returns distance during acceleration phase and distance during constant velocity phase for a virtual SGamma profiler. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Description This function is used to process synchrounous SingleAxisSlaveModeDisable command which is used to Disable the slave mode. Refer to the XPS Programmer's manual to get the command description. 2.2.128 SingleAxisSlaveParametersSet Syntax C# prototype int SingleAxisSlaveParametersSet(string GroupName, string PositionerName, double Ratio, out string errstring) Python prototype [errstring] SingleAxisSlaveParametersSet (GroupName, PositionerName, Ratio)
Command Interface Manual Description This function is used to process synchrounous SingleAxisSlaveParametersGet command which is used to Get slave parameters. Refer to the XPS Programmer's manual to get the command description. 2.2.130 OptionalModuleExecute Syntax C# prototype int OptionalModuleExecute(string ModuleFileName, string TaskName, out string errstring) Python prototype [errstring] OptionalModuleExecute (ModuleFileName, TaskName)
Command Interface Manual 2.2.132 ControllerStatusGet Syntax C# prototype int ControllerStatusGet(out Int32 ControllerStatus, out string errstring) Python prototype [ControllerStatus, errstring] ControllerStatusGet () Parameters Input parameters None Output parameters (Int32_i) ControllerStatus: ControllerStatus (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous ControllerStatusGet command which is used to Read controller current status.
Command Interface Manual 2.2.134 EEPROMCIESet Syntax C# prototype int EEPROMCIESet(Int32 CardNumber, string ReferenceString, out string errstring) Python prototype [errstring] EEPROMCIESet (CardNumber, ReferenceString) Parameters Input parameters (Int32) CardNumber: CardNumber (string) ReferenceString: ReferenceString Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EEPROMCIESet command which is used to Set CIE EEPROM reference string.
Command Interface Manual 2.2.136 EEPROMDriverSet Syntax C# prototype int EEPROMDriverSet(Int32 PlugNumber, string ReferenceString, out string errstring) Python prototype [errstring] EEPROMDriverSet (PlugNumber, ReferenceString) Parameters Input parameters (Int32) PlugNumber: PlugNumber (string) ReferenceString: ReferenceString Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous EEPROMDriverSet command which is used to Set Driver EEPROM reference string.
Command Interface Manual Output parameters (double) CPUTemperature: CPUTemperature (double) CPUFanSpeed: CPUFanSpeed (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous CPUTemperatureAndFanSpeedGet command which is used to Get CPU temperature and fan speed. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous RunTraceloggerProcessWithRollingBuffer command which is used to Run Tracelogger Process With Rolling Buffer. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Description This function is used to process synchrounous StartEventsAcqusition command which is used to Start Events Acqusition. Refer to the XPS Programmer's manual to get the command description. 2.2.144 StopEventsAcqusition Syntax C# prototype int StopEventsAcqusition( out string errstring) Python prototype [errstring] StopEventsAcqusition () Parameters...
Command Interface Manual 2.2.146 ActionListGet Syntax C# prototype int ActionListGet(out string ActionList, out string errstring) Python prototype [ActionList, errstring] ActionListGet () Parameters Input parameters None Output parameters (string) ActionList: ActionList (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous ActionListGet command which is used to Action list.
Command Interface Manual 2.2.148 APIExtendedListGet Syntax C# prototype int APIExtendedListGet(out string Method, out string errstring) Python prototype [Method, errstring] APIExtendedListGet () Parameters Input parameters None Output parameters (string) Method: Method (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous APIExtendedListGet command which is used to API method list.
Command Interface Manual 2.2.150 ErrorListGet Syntax C# prototype int ErrorListGet(out string ErrorsList, out string errstring) Python prototype [ErrorsList, errstring] ErrorListGet () Parameters Input parameters None Output parameters (string) ErrorsList: ErrorsList (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous ErrorListGet command which is used to Error list.
Command Interface Manual 2.2.152 GatheringListGet Syntax C# prototype int GatheringListGet(out string list, out string errstring) Python prototype [list, errstring] GatheringListGet () Parameters Input parameters None Output parameters (string) list: list (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringListGet command which is used to Gathering type list.
Command Interface Manual 2.2.154 GatheringExternalListGet Syntax C# prototype int GatheringExternalListGet(out string list, out string errstring) Python prototype [list, errstring] GatheringExternalListGet () Parameters Input parameters None Output parameters (string) list: list (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringExternalListGet command which is used to External Gathering type list.
Command Interface Manual 2.2.156 HardwareInternalListGet Syntax C# prototype int HardwareInternalListGet(out string InternalHardwareList, out string errstring) Python prototype [InternalHardwareList, errstring] HardwareInternalListGet () Parameters Input parameters None Output parameters (string) InternalHardwareList: InternalHardwareList (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HardwareInternalListGet command which is used to Internal hardware list.
Command Interface Manual 2.2.158 HexapodTrajectoryListGet Syntax C# prototype int HexapodTrajectoryListGet(out string list, out string errstring) Python prototype [list, errstring] HexapodTrajectoryListGet () Parameters Input parameters None Output parameters (string) list: list (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous HexapodTrajectoryListGet command which is used to Hexapod trajectory type list.
Command Interface Manual 2.2.160 PositionerErrorListGet Syntax C# prototype int PositionerErrorListGet(out string PositionerErrorList, out string errstring) Python prototype [PositionerErrorList, errstring] PositionerErrorListGet () Parameters Input parameters None Output parameters (string) PositionerErrorList: PositionerErrorList (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerErrorListGet command which is used to Positioner error list.
Command Interface Manual 2.2.162 PositionerDriverStatusListGet Syntax C# prototype int PositionerDriverStatusListGet(out string PositionerDriverStatusList, out string errstring) Python prototype [PositionerDriverStatusList, errstring] PositionerDriverStatusListGet () Parameters Input parameters None Output parameters (string) PositionerDriverStatusList: PositionerDriverStatusList (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PositionerDriverStatusListGet command which is used to Positioner driver status list.
Command Interface Manual 2.2.164 ReferencingSensorListGet Syntax C# prototype int ReferencingSensorListGet(out string list, out string errstring) Python prototype [list, errstring] ReferencingSensorListGet () Parameters Input parameters None Output parameters (string) list: list (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous ReferencingSensorListGet command which is used to Get referencing sensor list.
Command Interface Manual Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous GatheringUserDatasGet command which is used to Return UserDatas values. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Parameters Input parameters None Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous ControllerMotionKernelPeriodMinMaxReset command which is used to Reset controller motion kernel min/max periods.
Page 101
Command Interface Manual Output parameters (string) errString: The failure reason Return (int) error code: 0 in success and -1 on failure Description This function is used to process synchrounous PrepareForUpdate command which is used to Kill QNX processes for firmware update. Refer to the XPS Programmer's manual to get the command description.
Command Interface Manual Examples Python Script #======================================================================== # Newport Proprietary and Confidential Newport Corporation 2011 # No part of this file in any format, with or without modification # shall be used, copied or distributed without the express written # consent of Newport Corporation.
Page 103
Command Interface Manual # Get object list print '---------------- Object list ----------------' result, response, errString = hxp.ObjectsListGet() objectList = response.split(';') nbObjects = len(objectList) result == range(nbObjects): print i+1, ', objectList[i] else: print 'Error=>', result, " : ", errString # Get GPIO analog gain print '------------ GPIO analog gain ---------------' from...
Page 104
Command Interface Manual #region Constants const int DEFAULT_TO = 1000; // timeout in milliseconds const int DEFAULT_PORT = 5001; const string DEFAULT_ADDRESS = "192.168.33.3"; #endregion Constants #region Members /// <summary> Object of HXP Command Interface /// </summary> m_hxpInterface; /// <summary> Controller’s version /// </summary>...
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: ____________________________________________ Fax Number: ____________________________________________ Item(s) Being Returned: ____________________________________ Model#: ________________________________________________ Serial #: ________________________________________________...
Page 108
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...
Need help?
Do you have a question about the MKS HXP Series and is the answer not in the manual?
Questions and answers