Wittenstein attocube AMC100 Interface Manual Download Page 19

Page: 19 / 205

Page 16

Table of Contents

grantAccess
Grants access to a locked device for the requesting IP by checking
against the password

Function specific parameters

password

string the current password

errNo

errorCode

JSON Method

method: grantAccess

params: [password]

Result: [errNo]

C-DLL call

int AMC_grantAccess(int deviceHandle, const char* password)

Python

[dev].access.grantAccess(password)

Matlab

[] = AMC_grantAccess(password)

void value = [Device].GrantAccess(string password)

LabVIEW

grantAccess.vi

Summary of Contents for attocube AMC100

Page 1: ...Interface Manual AMC100 AMC300...

Page 2: ...ver Application MOVE 2021 attocube systems AG Product and company names listed are trademarks or trade names of their respective companies Any rights not expressly granted herein are reserved ATTENTIO...

Page 3: ......

Page 4: ...and implementation of the APIs 5 2 2 1 JSON RPC JRPC2 0 5 2 2 2 C Library 6 2 2 3 C Library 8 2 2 4 LabVIEW 9 2 2 5 Matlab 11 2 2 6 Python 11 2 3 Error handling 13 2 3 1 C error handling 13 2 3 2 Pyt...

Page 5: ...third party hardware o Do carefully observe the information in this section when combining the device with third party hardware NOTE attocube is not liable for any damages resulting from an unauthori...

Page 6: ...essible within every interface This is why we sort by functions not by interfaces For every function we show how the implementation in the particular interface is done Anyway first we give a short exp...

Page 7: ...ady made VIs to have a fast and easy implementation in National Instrument s LabVIEW environment 2 1 5 Matlab Library Based on the JSON interface we offer ready made Matlab functios to have a fast and...

Page 8: ...in chapter 2 2 param x Parameter for the method call if the PARAM is put between two it is a string Without it is a number call id A unique id to find the corresponding answer api version A version i...

Page 9: ...ntains of following files Standard C API attocubeJSON dll x64 and x86 versions for a windows environment attocubeJSON lib x64 and x86 versions for a windows environment attocubeJSON so x64 and x86 ver...

Page 10: ...90 is used Discovering devices within the same network The discovery function can be used It searches your network for available attocube devices and returns a list of properties This is done by a SSD...

Page 11: ...ess 32 MAC address of the device bool locked Device locked by other program DeviceInfo typedef enum IDS MOTION_CTRLER BOTH deviceType Overview The C API contains of following files CSharpAPIDLL dll co...

Page 12: ...d It searches your network for available devices and returns a list of properties This is done by an SSDP broadcast If no devices are found please check the device connection via TCP IP e g via the we...

Page 13: ...undled into clusters In case you still want to use those low level VIs instead they can be found inside folders that contain the word SubVIs For code cleanliness it is not recommended to use those How...

Page 14: ...DeviceHandle Both functions are included in the API For a TCP IP connection use the port 9090 Overview The Python API contains a folder with domain specific files To have access to the python functio...

Page 15: ...list of properties This is done by an SSDP broadcast If no devices are found please check the device connection via TCP IP e g via the websever or make sure that the device is in the same subnet than...

Page 16: ...handling try attoDevice Method catch AttocubeApiException e int err e ErrorCode passes the errorcode of type int to the variable err string errmsg attoDevice ErrorNumberToString 0 err converts err in...

Page 17: ...fluence the execution of the following VIs they are used to inform the user Real errors hinder the execution of following VIs they are meant to stop the program Examples are shown below Example Exampl...

Page 18: ...errNo errorCode locked Is the device locked authorized Is the client authorized JSON Method method getLockStatus params Result errNo locked authorized C DLL call int AMC_getLockStatus int deviceHandle...

Page 19: ...c parameters In password string the current password Out errNo errorCode JSON Method method grantAccess params password Result errNo C DLL call int AMC_grantAccess int deviceHandle const char password...

Page 20: ...added to the devices which can access functions Function specific parameters In password string the password to be set Out errNo errorCode JSON Method method lock params password Result errNo C DLL ca...

Page 21: ...y function Function specific parameters In password string the current password Out errNo errorCode JSON Method method unlock params password Result errNo C DLL call int AMC_unlock int deviceHandle co...

Page 22: ...f the AMC to get the soft limit status from Out errNo int32 Error number if one occured 0 in case of no error limit double Lower boundary in pm JSON Method method com attocube amc amcids getLowerSoftL...

Page 23: ...mit status from Out errNo int32 Error number if one occured 0 in case of no error enabled boolean True if the soft limit should be enabled on this axis JSON Method method com attocube amc amcids getSo...

Page 24: ...soft limit status from Out errNo int32 Error number if one occured 0 in case of no error enabled boolean True if the position is not within the boundaries JSON Method method com attocube amc amcids g...

Page 25: ...of the AMC to get the soft limit status from Out errNo int32 Error number if one occured 0 in case of no error limit double Upper boundary in pm JSON Method method com attocube amc amcids getUpperSoft...

Page 26: ...stead Function specific parameters In axis Axis of the IDS to reset the position Out errNo int32 Error number if one occured 0 in case of no error JSON Method method com attocube amc amcids resetIdsAx...

Page 27: ...he AMC where the soft limit should be changed limit Lower boundary in pm Out errNo int32 Error number if one occured 0 in case of no error JSON Method method com attocube amc amcids setLowerSoftLimit...

Page 28: ...changed enabled True if the soft limit should be enabled on this axis Out errNo int32 Error number if one occured 0 in case of no error JSON Method method com attocube amc amcids setSoftLimitEnabled p...

Page 29: ...he AMC where the soft limit should be changed limit Upper boundary in pm Out errNo int32 Error number if one occured 0 in case of no error JSON Method method com attocube amc amcids setUpperSoftLimit...

Page 30: ...otherwise pos3 target is ignored target1 target position of axis 1 target2 target position of axis 2 target3 target position of axis 3 Out errNo errNo ref1 Status of axis 1 ref2 Status of axis 2 ref3...

Page 31: ...s1 int refpos2 int refpos3 int pos1 int pos2 int pos3 Python ref1 ref2 ref3 refpos1 refpos2 refpos3 pos1 pos2 pos3 dev control MultiAxisPositioning set1 set2 set3 target1 target2 target3 Matlab ref1 r...

Page 32: ...e actor_name JSON Method method com attocube amc control getActorName params axis Result errNo actor_name C DLL call int AMC_control_getActorName int deviceHandle int axis char actor_name int size0 Py...

Page 33: ...mc control getActorParametersActorName params axis Result errNo actorname C DLL call int AMC_control_getActorParametersActorName int deviceHandle int axis char actorname int size0 Python actorname dev...

Page 34: ...ethod method com attocube amc control getActorSensitivity params axis Result errNo sensitivity C DLL call int AMC_control_getActorSensitivity int deviceHandle int axis int sensitivity Python sensitivi...

Page 35: ...pe 0 linear 1 goniometer 2 rotator JSON Method method com attocube amc control getActorType params axis Result errNo actor_type C DLL call int AMC_control_getActorType int deviceHandle int axis int ac...

Page 36: ...automeasurement false disable automeasurement JSON Method method com attocube amc control getAutoMeasure params axis Result errNo enable C DLL call int AMC_control_getAutoMeasure int deviceHandle int...

Page 37: ...tude in mV JSON Method method com attocube amc control getControlAmplitude params axis Result errNo amplitude C DLL call int AMC_control_getControlAmplitude int deviceHandle int axis int amplitude Pyt...

Page 38: ...ed boolean JSON Method method com attocube amc control getControlAutoReset params axis Result errNo enabled C DLL call int AMC_control_getControlAutoReset int deviceHandle int axis bool enabled Python...

Page 39: ...om attocube amc control getControlFixOutputVoltage params axis Result errNo amplitude_mv C DLL call int AMC_control_getControlFixOutputVoltage int deviceHandle int axis int amplitude_mv Python amplitu...

Page 40: ...in mHz JSON Method method com attocube amc control getControlFrequency params axis Result errNo frequency C DLL call int AMC_control_getControlFrequency int deviceHandle int axis int frequency Python...

Page 41: ...rue closed loop control enabled false closed loop control disabled JSON Method method com attocube amc control getControlMove params axis Result errNo enable C DLL call int AMC_control_getControlMove...

Page 42: ...us true enabled false disabled JSON Method method com attocube amc control getControlOutput params axis Result errNo enabled C DLL call int AMC_control_getControlOutput int deviceHandle int axis bool...

Page 43: ...fic parameters In axis 0 1 2 Out errNo errNo enabled boolen JSON Method method com attocube amc control getControlReferenceAutoUpdate params axis Result errNo enabled C DLL call int AMC_control_getCon...

Page 44: ...trange in nm JSON Method method com attocube amc control getControlTargetRange params axis Result errNo targetrange C DLL call int AMC_control_getControlTargetRange int deviceHandle int axis int targe...

Page 45: ...til the controller is acting again in microseconds JSON Method method com attocube amc control getCrosstalkThreshold params axis Result errNo range time C DLL call int AMC_control_getCrosstalkThreshol...

Page 46: ...thod method com attocube amc control getCurrentOutputVoltage params axis Result errNo amplitude C DLL call int AMC_control_getCurrentOutputVoltage int deviceHandle int axis int amplitude Python amplit...

Page 47: ...eters In axis 0 1 2 Out errNo errNo enabled enabled JSON Method method com attocube amc control getExternalSensor params axis Result errNo enabled C DLL call int AMC_control_getExternalSensor int devi...

Page 48: ...ge in pm JSON Method method com attocube amc control getMotionControlThreshold params axis Result errNo range C DLL call int AMC_control_getMotionControlThreshold int deviceHandle int axis int range P...

Page 49: ...mV val3 dc voltage of of axis 3 in mV JSON Method method com attocube amc control getPositionsAndVoltages params Result errNo pos1 pos2 pos3 val1 val2 val3 C DLL call int AMC_control_getPositionsAndV...

Page 50: ...n nm for goniometer an rotator type actors it is JSON Method method com attocube amc control getReferencePosition params axis Result errNo position C DLL call int AMC_control_getReferencePosition int...

Page 51: ...eters In axis 0 1 2 Out errNo errNo inverted boolen JSON Method method com attocube amc control getSensorDirection params axis Result errNo inverted C DLL call int AMC_control_getSensorDirection int d...

Page 52: ...therwise JSON Method method com attocube amc control getSensorEnabled params axis Result errNo value C DLL call int AMC_control_getSensorEnabled int deviceHandle int axis bool value Python value dev c...

Page 53: ...SON Method method com attocube amc control getStatusMovingAllAxes params Result errNo moving1 moving2 moving3 C DLL call int AMC_control_getStatusMovingAllAxes int deviceHandle int moving1 int moving2...

Page 54: ...errNo JSON Method method com attocube amc control searchReferencePosition params axis Result errNo C DLL call int AMC_control_searchReferencePosition int deviceHandle int axis Python dev control sear...

Page 55: ...ctor Out errNo errNo JSON Method method com attocube amc control setActorParametersByName params axis actorname Result errNo C DLL call int AMC_control_setActorParametersByName int deviceHandle int ax...

Page 56: ...t errNo errorCode JSON Method method com attocube amc control setActorParametersJson params axis json_dict Result errNo C DLL call int AMC_control_setActorParametersJson int deviceHandle int axis cons...

Page 57: ...od com attocube amc control setActorSensitivity params axis sensitivity Result errNo C DLL call int AMC_control_setActorSensitivity int deviceHandle int axis int sensitivity Python dev control setActo...

Page 58: ...e disable automeasurement Out errNo errNo JSON Method method com attocube amc control setAutoMeasure params axis enable Result errNo C DLL call int AMC_control_setAutoMeasure int deviceHandle int axis...

Page 59: ...No JSON Method method com attocube amc control setControlAmplitude params axis amplitude Result errNo C DLL call int AMC_control_setControlAmplitude int deviceHandle int axis int amplitude Python dev...

Page 60: ...errNo JSON Method method com attocube amc control setControlAutoReset params axis enable Result errNo C DLL call int AMC_control_setControlAutoReset int deviceHandle int axis bool enable Python dev c...

Page 61: ...errNo JSON Method method com attocube amc control setControlFixOutputVoltage params axis amplitude_mv Result errNo C DLL call int AMC_control_setControlFixOutputVoltage int deviceHandle int axis int a...

Page 62: ...is 0 1 2 frequency in mHz Out errNo errNo JSON Method method com attocube amc control setControlFrequency params axis frequency Result errNo C DLL call int AMC_control_setControlFrequency int deviceHa...

Page 63: ...approach false disable the approach Out errNo errNo JSON Method method com attocube amc control setControlMove params axis enable Result errNo C DLL call int AMC_control_setControlMove int deviceHand...

Page 64: ...1 2 enable true enable drives false disable drives Out errNo errNo JSON Method method com attocube amc control setControlOutput params axis enable Result errNo C DLL call int AMC_control_setControlOu...

Page 65: ...parameters In axis 0 1 2 enable boolean Out errNo errNo JSON Method method com attocube amc control setControlReferenceAutoUpdate params axis enable Result errNo C DLL call int AMC_control_setControlR...

Page 66: ...in nm Out errNo errNo JSON Method method com attocube amc control setControlTargetRange params axis range Result errNo C DLL call int AMC_control_setControlTargetRange int deviceHandle int axis int r...

Page 67: ...econds Out errNo errNo JSON Method method com attocube amc control setCrosstalkThreshold params axis threshold slipphasetime Result errNo C DLL call int AMC_control_setCrosstalkThreshold int deviceHan...

Page 68: ...d Function specific parameters In axis 0 1 2 enabled Out warning warning JSON Method method com attocube amc control setExternalSensor params axis enabled Result warning C DLL call int AMC_control_set...

Page 69: ...pm Out errNo errNo JSON Method method com attocube amc control setMotionControlThreshold params axis threshold Result errNo C DLL call int AMC_control_setMotionControlThreshold int deviceHandle int a...

Page 70: ...For IDS use com attocube ids displacement resetAxis or com attocube amc amcids resetIdsAxis instead Function specific parameters In axis 0 1 2 Out errNo errNo JSON Method method com attocube amc cont...

Page 71: ...ers In axis 0 1 2 inverted Out errNo errNo JSON Method method com attocube amc control setSensorDirection params axis inverted Result errNo C DLL call int AMC_control_setSensorDirection int deviceHand...

Page 72: ...tion specific parameters In axis 0 1 2 value true if enabled false otherwise Out errNo errNo JSON Method method com attocube amc control setSensorEnabled params axis value Result errNo C DLL call int...

Page 73: ...hassisNbr JSON Method method com attocube amc description checkChassisNbr params Result errNo slotNbr chassisNbr C DLL call int AMC_description_checkChassisNbr int deviceHandle int slotNbr int chassis...

Page 74: ...attached feature AMC100 NUM AMC100 NUM PRO JSON Method method com attocube amc description getDeviceType params Result errNo devicetype C DLL call int AMC_description_getDeviceType int deviceHandle ch...

Page 75: ...ation Pro Wireless Controller IO JSON Method method com attocube amc description getFeaturesActivated params Result errNo features C DLL call int AMC_description_getFeaturesActivated int deviceHandle...

Page 76: ...Method method com attocube amc description getPositionersList params Result errNo PositionersList C DLL call int AMC_description_getPositionersList int deviceHandle char PositionersList int size0 Pyth...

Page 77: ...JSON Method method com attocube amc diagnostic getDiagnosticPower params axis Result errNo power C DLL call int AMC_diagnostic_getDiagnosticPower int deviceHandle int axis int power Python power dev d...

Page 78: ...JSON Method method com attocube amc diagnostic getDiagnosticResults params axis Result errNo capacity resistance C DLL call int AMC_diagnostic_getDiagnosticResults int deviceHandle int axis int capac...

Page 79: ...be amc diagnostic getDiagnosticTemperature params axis Result errNo temperature C DLL call int AMC_diagnostic_getDiagnosticTemperature int deviceHandle int axis int temperature Python temperature dev...

Page 80: ...No errNo JSON Method method com attocube amc diagnostic startDiagnostic params axis Result errNo C DLL call int AMC_diagnostic_startDiagnostic int deviceHandle int axis Python dev diagnostic startDiag...

Page 81: ...ard is active false otherwise JSON Method method com attocube amc move getControlContinuousBkwd params axis Result errNo enabled C DLL call int AMC_move_getControlContinuousBkwd int deviceHandle int a...

Page 82: ...tive false otherwise JSON Method method com attocube amc move getControlContinuousFwd params axis Result errNo enabled C DLL call int AMC_move_getControlContinuousFwd int deviceHandle int axis bool en...

Page 83: ...l be deactivated on positive EOT detection JSON Method method com attocube amc move getControlEotOutputDeactive params axis Result errNo enabled C DLL call int AMC_move_getControlEotOutputDeactive int...

Page 84: ...rotator type actors it is JSON Method method com attocube amc move getControlTargetPosition params axis Result errNo position C DLL call int AMC_move_getControlTargetPosition int deviceHandle int axis...

Page 85: ...errNo 0 or error grounded true or false JSON Method method com attocube amc move getGroundAxis params axis Result errNo grounded C DLL call int AMC_move_getGroundAxis int deviceHandle int axis bool gr...

Page 86: ...rrNo 0 or error value true or false JSON Method method com attocube amc move getGroundAxisAutoOnTarget params axis Result errNo value C DLL call int AMC_move_getGroundAxisAutoOnTarget int deviceHandle...

Page 87: ...No errNo targetrange in nm JSON Method method com attocube amc move getGroundTargetRange params axis Result errNo targetrange C DLL call int AMC_move_getGroundTargetRange int deviceHandle int axis int...

Page 88: ...2 Out errNo errNo nbrstep nbrstep JSON Method method com attocube amc move getNSteps params axis Result errNo nbrstep C DLL call int AMC_move_getNSteps int deviceHandle int axis int nbrstep Python nb...

Page 89: ...is 0 1 2 Out errNo errNo position defined in nm for goniometer an rotator type actors it is JSON Method method com attocube amc move getPosition params axis Result errNo position C DLL call int AMC_mo...

Page 90: ...a valid reference position Function specific parameters In axis 0 1 2 Out errNo errNo JSON Method method com attocube amc move moveReference params axis Result errNo C DLL call int AMC_move_moveRefer...

Page 91: ...p true a backward step Out errNo errNo JSON Method method com attocube amc move performNSteps params axis backward Result errNo C DLL call int AMC_move_performNSteps int deviceHandle int axis const ch...

Page 92: ...tops all movement of the axis regardless its direction Out errNo errNo JSON Method method com attocube amc move setControlContinuousBkwd params axis enable Result errNo C DLL call int AMC_move_setCont...

Page 93: ...false stops all movement of the axis regardless its direction Out errNo errNo JSON Method method com attocube amc move setControlContinuousFwd params axis enable Result errNo C DLL call int AMC_move_s...

Page 94: ...EOT detection Out errNo errNo JSON Method method com attocube amc move setControlEotOutputDeactive params axis enable Result errNo C DLL call int AMC_move_setControlEotOutputDeactive int deviceHandle...

Page 95: ...n is defined in nm for goniometer an rotator type actors it is Out errNo errNo JSON Method method com attocube amc move setControlTargetPosition params axis target Result errNo C DLL call int AMC_move...

Page 96: ...enabled true or false Out errNo 0 or error JSON Method method com attocube amc move setGroundAxis params axis enabled Result errNo C DLL call int AMC_move_setGroundAxis int deviceHandle int axis bool...

Page 97: ...enabled true or false Out errNo 0 or error JSON Method method com attocube amc move setGroundAxisAutoOnTarget params axis enabled Result errNo C DLL call int AMC_move_setGroundAxisAutoOnTarget int dev...

Page 98: ...in nm Out errNo errNo JSON Method method com attocube amc move setGroundTargetRange params axis range Result errNo C DLL call int AMC_move_setGroundTargetRange int deviceHandle int axis int range Pyt...

Page 99: ...a forward step true a backward step step number of step Out errNo errNo JSON Method method com attocube amc move setNSteps params axis backward step Result errNo C DLL call int AMC_move_setNSteps int...

Page 100: ...iggers a forward step true a backward step Out errNo errNo JSON Method method com attocube amc move setSingleStep params axis backward Result errNo C DLL call int AMC_move_setSingleStep int deviceHand...

Page 101: ...1 2 step number of step Out errNo errNo JSON Method method com attocube amc move writeNSteps params axis step Result errNo C DLL call int AMC_move_writeNSteps int deviceHandle int axis int step Pytho...

Page 102: ...eff gaincoeff JSON Method method com attocube amc res getChainGain params axis Result errNo gaincoeff C DLL call int AMC_res_getChainGain int deviceHandle int axis int gaincoeff Python gaincoeff dev r...

Page 103: ...d true when enabled JSON Method method com attocube amc res getLinearization params axis Result errNo enabled C DLL call int AMC_res_getLinearization int deviceHandle int axis bool enabled Python enab...

Page 104: ...No value_string1 string identifier JSON Method method com attocube amc res getLutSn params axis Result errNo value_string1 C DLL call int AMC_res_getLutSn int deviceHandle int axis char value_string1...

Page 105: ...cific parameters Out errNo errNo mode mode JSON Method method com attocube amc res getMode params Result errNo mode C DLL call int AMC_res_getMode int deviceHandle int mode Python mode dev res getMode...

Page 106: ...0 dB 2 15 dB 3 20 dB Out errNo errNo JSON Method method com attocube amc res setChainGain params axis gainconfig Result errNo C DLL call int AMC_res_setChainGain int deviceHandle int axis int gainconf...

Page 107: ...tring or JSON File Out errNo errNo JSON Method method com attocube amc res setConfigurationFile params axis content Result errNo C DLL call int AMC_res_setConfigurationFile int deviceHandle int axis c...

Page 108: ...on Out errNo errNo JSON Method method com attocube amc res setLinearization params axis enable Result errNo C DLL call int AMC_res_setLinearization int deviceHandle int axis bool enable Python dev res...

Page 109: ...o frequency rejection method 2 Mic Mode with dual frequency rejection method Out errNo errNo JSON Method method com attocube amc res setMode params mode Result errNo C DLL call int AMC_res_setMode int...

Page 110: ...target range false at least one axis is not in target range JSON Method method com attocube amc rotcomp getControlTargetRanges params Result errNo in_target_range C DLL call int AMC_rotcomp_getControl...

Page 111: ...r ok enabled boolean true Rotation compensation is enabled false Rotation compensation is disabled JSON Method method com attocube amc rotcomp getEnabled params Result errNo enabled C DLL call int AMC...

Page 112: ...erwise 0 for ok lut string JSON string of the LUT file for the rotation compensation JSON Method method com attocube amc rotcomp getLUT params Result errNo lut C DLL call int AMC_rotcomp_getLUT int de...

Page 113: ...sation is disabled Out errNo int32 Error code if there was an error otherwise 0 for ok JSON Method method com attocube amc rotcomp setEnabled params enabled Result errNo C DLL call int AMC_rotcomp_set...

Page 114: ...Out errNo int32 Error code if there was an error otherwise 0 for ok JSON Method method com attocube amc rotcomp setLUT params lut_string Result errNo C DLL call int AMC_rotcomp_setLUT int deviceHandle...

Page 115: ...k JSON Method method com attocube amc rotcomp updateOffsets params offset_axis0 offset_axis1 offset_axis2 Result errNo C DLL call int AMC_rotcomp_updateOffsets int deviceHandle int offset_axis0 int of...

Page 116: ...unction Function specific parameters Out errNo errNo JSON Method method com attocube amc rtin apply params Result errNo C DLL call int AMC_rtin_apply int deviceHandle Python dev rtin apply Matlab rtin...

Page 117: ...t applieds Function specific parameters Out errNo errNo JSON Method method com attocube amc rtin discard params Result errNo C DLL call int AMC_rtin_discard int deviceHandle Python dev rtin discard Ma...

Page 118: ...hod com attocube amc rtin getControlAQuadBInResolution params axis Result errNo resolution C DLL call int AMC_rtin_getControlAQuadBInResolution int deviceHandle int axis int resolution Python resoluti...

Page 119: ...oolean true approach enabled false approach disabled JSON Method method com attocube amc rtin getControlMoveGPIO params axis Result errNo enable C DLL call int AMC_rtin_getControlMoveGPIO int deviceHa...

Page 120: ...pio_mode 0 Standard GPIO 1 NSL Mic Mode JSON Method method com attocube amc rtin getGpioMode params Result errNo gpio_mode C DLL call int AMC_rtin_getGpioMode int deviceHandle int gpio_mode Python gpi...

Page 121: ...Off 1 Axis 1 2 Axis 2 3 Axis 3 Out errNo errNo JSON Method method com attocube amc rtin getNslMux params mux_mode Result errNo C DLL call int AMC_rtin_getNslMux int deviceHandle int mux_mode Python de...

Page 122: ...n current pos in nm JSON Method method com attocube amc rtin getRealTimeInChangePerPulse params axis Result errNo resolution C DLL call int AMC_rtin_getRealTimeInChangePerPulse int deviceHandle int ax...

Page 123: ...1 close loop JSON Method method com attocube amc rtin getRealTimeInFeedbackLoopMode params axis Result errNo mode C DLL call int AMC_rtin_getRealTimeInFeedbackLoopMode int deviceHandle int axis int m...

Page 124: ...errNo mode see RT_IN_MODES JSON Method method com attocube amc rtin getRealTimeInMode params axis Result errNo mode C DLL call int AMC_rtin_getRealTimeInMode int deviceHandle int axis int mode Python...

Page 125: ...er of steps to applied JSON Method method com attocube amc rtin getRealTimeInStepsPerPulse params axis Result errNo steps C DLL call int AMC_rtin_getRealTimeInStepsPerPulse int deviceHandle int axis i...

Page 126: ...attocube amc rtin setControlAQuadBInResolution params axis resolution Result errNo C DLL call int AMC_rtin_setControlAQuadBInResolution int deviceHandle int axis int resolution Python dev rtin setCont...

Page 127: ...proach false disable the approach Out errNo errNo JSON Method method com attocube amc rtin setControlMoveGPIO params axis enable Result errNo C DLL call int AMC_rtin_setControlMoveGPIO int deviceHandl...

Page 128: ...1 NSL Mic Mode Out errNo errNo JSON Method method com attocube amc rtin setGpioMode params gpio_mode Result errNo C DLL call int AMC_rtin_setGpioMode int deviceHandle int gpio_mode Python dev rtin set...

Page 129: ...Off 1 Axis 1 2 Axis 2 3 Axis 3 Out errNo errNo JSON Method method com attocube amc rtin setNslMux params mux_mode Result errNo C DLL call int AMC_rtin_setNslMux int deviceHandle int mux_mode Python de...

Page 130: ...to current position in nm Out errNo errNo JSON Method method com attocube amc rtin setRealTimeInChangePerPulse params axis delta Result errNo C DLL call int AMC_rtin_setRealTimeInChangePerPulse int de...

Page 131: ...No errNo JSON Method method com attocube amc rtin setRealTimeInFeedbackLoopMode params axis mode Result errNo C DLL call int AMC_rtin_setRealTimeInFeedbackLoopMode int deviceHandle int axis int mode P...

Page 132: ...realtime Out errNo errNo JSON Method method com attocube amc rtin setRealTimeInMode params axis mode Result errNo C DLL call int AMC_rtin_setRealTimeInMode int deviceHandle int axis int mode Python d...

Page 133: ...steps to applied Out errNo errNo JSON Method method com attocube amc rtin setRealTimeInStepsPerPulse params axis steps Result errNo C DLL call int AMC_rtin_setRealTimeInStepsPerPulse int deviceHandle...

Page 134: ...ion Function specific parameters Out errNo errNo JSON Method method com attocube amc rtout apply params Result errNo C DLL call int AMC_rtout_apply int deviceHandle Python dev rtout apply Matlab rtout...

Page 135: ...ers In axis 0 1 2 Out errNo errNo JSON Method method com attocube amc rtout applyAxis params axis Result errNo C DLL call int AMC_rtout_applyAxis int deviceHandle int axis Python dev rtout applyAxis a...

Page 136: ...pplied yet Function specific parameters Out errNo errNo JSON Method method com attocube amc rtout discard params Result errNo C DLL call int AMC_rtout_discard int deviceHandle Python dev rtout discard...

Page 137: ...cific parameters In axis 0 1 2 Out errNo errNo JSON Method method com attocube amc rtout discardAxis params axis Result errNo C DLL call int AMC_rtout_discardAxis int deviceHandle int axis Python dev...

Page 138: ...Out errNo errNo JSON Method method com attocube amc rtout discardSignalMode params Result errNo C DLL call int AMC_rtout_discardSignalMode int deviceHandle Python dev rtout discardSignalMode Matlab rt...

Page 139: ...nabled boolean JSON Method method com attocube amc rtout getControlAQuadBOut params axis Result errNo enabled C DLL call int AMC_rtout_getControlAQuadBOut int deviceHandle int axis bool enabled Python...

Page 140: ...310700ms JSON Method method com attocube amc rtout getControlAQuadBOutClock params axis Result errNo clock_in_ns C DLL call int AMC_rtout_getControlAQuadBOutClock int deviceHandle int axis int clock_i...

Page 141: ...od com attocube amc rtout getControlAQuadBOutResolution params axis Result errNo resolution C DLL call int AMC_rtout_getControlAQuadBOutResolution int deviceHandle int axis int resolution Python resol...

Page 142: ...ff 1 AquadB 2 Trigger JSON Method method com attocube amc rtout getMode params axis Result errNo mode C DLL call int AMC_rtout_getMode int deviceHandle int axis int mode Python mode dev rtout getMode...

Page 143: ...arameters Out errNo errNo mode 0 TTL 1 LVDS JSON Method method com attocube amc rtout getSignalMode params Result errNo mode C DLL call int AMC_rtout_getSignalMode int deviceHandle int mode Python mod...

Page 144: ...Method method com attocube amc rtout getTriggerConfig params axis Result errNo higher lower epsilon polarity C DLL call int AMC_rtout_getTriggerConfig int deviceHandle int axis int higher int lower i...

Page 145: ...Out errNo errNo JSON Method method com attocube amc rtout setControlAQuadBOutClock params axis clock Result errNo C DLL call int AMC_rtout_setControlAQuadBOutClock int deviceHandle int axis int clock...

Page 146: ...ube amc rtout setControlAQuadBOutResolution params axis resolution Result errNo C DLL call int AMC_rtout_setControlAQuadBOutResolution int deviceHandle int axis int resolution Python dev rtout setCont...

Page 147: ...1 AquadB 2 Trigger Out errNo errNo JSON Method method com attocube amc rtout setMode params axis mode Result errNo C DLL call int AMC_rtout_setMode int deviceHandle int axis int mode Python dev rtout...

Page 148: ...n mode 0 TTL 1 LVDS Out errNo errNo JSON Method method com attocube amc rtout setSignalMode params mode Result errNo C DLL call int AMC_rtout_setSignalMode int deviceHandle int mode Python dev rtout s...

Page 149: ...method com attocube amc rtout setTriggerConfig params axis higher lower epsilon polarity Result errNo C DLL call int AMC_rtout_setTriggerConfig int deviceHandle int axis int higher int lower int epsil...

Page 150: ...mit reached forward limit reached positioner not connected output not enabled JSON Method method com attocube amc status getFullCombinedStatus params axis Result errNo value_string1 C DLL call int AMC...

Page 151: ...oner connected 2 No positioner connected 3 RES positione connected JSON Method method com attocube amc status getOlStatus params axis Result errNo sensorstatus C DLL call int AMC_status_getOlStatus in...

Page 152: ...If true the actor is connected JSON Method method com attocube amc status getStatusConnected params axis Result errNo connected C DLL call int AMC_status_getStatusConnected int deviceHandle int axis b...

Page 153: ...No errNo detected true when EoT in either direction was detected JSON Method method com attocube amc status getStatusEot params axis Result errNo detected C DLL call int AMC_status_getStatusEot int de...

Page 154: ...errNo detected true when EoT was detected JSON Method method com attocube amc status getStatusEotBkwd params axis Result errNo detected C DLL call int AMC_status_getStatusEotBkwd int deviceHandle int...

Page 155: ...errNo errNo detected true when EoT was detected JSON Method method com attocube amc status getStatusEotFwd params axis Result errNo detected C DLL call int AMC_status_getStatusEotFwd int deviceHandle...

Page 156: ...or closed loop approach or continous single stepping and the output is active 2 Pending means the output stage is driving but the output is deactivated JSON Method method com attocube amc status getSt...

Page 157: ...id true valid false not valid JSON Method method com attocube amc status getStatusReference params axis Result errNo valid C DLL call int AMC_status_getStatusReference int deviceHandle int axis bool v...

Page 158: ...the position in a loop Function specific parameters In axis 0 1 2 Out errNo errNo in_range true within the target range false not within the target range JSON Method method com attocube amc status get...

Page 159: ...of packages JSON Method method com attocube system about getInstalledPackages params Result errNo value_string1 C DLL call int system_about_getInstalledPackages int deviceHandle char value_string1 int...

Page 160: ...Method method com attocube system about getPackageLicense params pckg Result errNo value_string1 C DLL call int system_about_getPackageLicense int deviceHandle const char pckg char value_string1 int...

Page 161: ...tem configuration Function specific parameters Out errNo errorCode JSON Method method com attocube system apply params Result errNo C DLL call int system_apply int deviceHandle Python dev system_servi...

Page 162: ...ns JSON Method method com attocube system errorNumberToRecommendation params language errNbr Result errNo value_string1 C DLL call int system_errorNumberToRecommendation int deviceHandle int language...

Page 163: ...tring Error description JSON Method method com attocube system errorNumberToString params language errNbr Result errNo value_string1 C DLL call int system_errorNumberToString int deviceHandle int lang...

Page 164: ...o default and the IDS will be configured as DHCP server Function specific parameters Out errNo errorCode JSON Method method com attocube system factoryReset params Result errNo C DLL call int system_f...

Page 165: ...ual device name JSON Method method com attocube system getDeviceName params Result errNo value_string1 C DLL call int system_getDeviceName int deviceHandle char value_string1 int size0 Python value_st...

Page 166: ...rsion JSON Method method com attocube system getFirmwareVersion params Result errNo value_string1 C DLL call int system_getFirmwareVersion int deviceHandle char value_string1 int size0 Python value_st...

Page 167: ...1 string flux code JSON Method method com attocube system getFluxCode params Result errNo value_string1 C DLL call int system_getFluxCode int deviceHandle char value_string1 int size0 Python value_str...

Page 168: ...le available JSON Method method com attocube system getHostname params Result errNo available C DLL call int system_getHostname int deviceHandle char available int size0 Python available dev system_se...

Page 169: ...address of the system JSON Method method com attocube system getMacAddress params Result errNo value_string1 C DLL call int system_getMacAddress int deviceHandle char value_string1 int size0 Python v...

Page 170: ...l number JSON Method method com attocube system getSerialNumber params Result errNo value_string1 C DLL call int system_getSerialNumber int deviceHandle char value_string1 int size0 Python value_strin...

Page 171: ...ad it Function specific parameters Out errNo errorCode JSON Method method com attocube system network apply params Result errNo C DLL call int system_network_apply int deviceHandle Python dev network...

Page 172: ...ON Method method com attocube system network configureWifi params mode ssid psk Result errNo C DLL call int system_network_configureWifi int deviceHandle int mode const char ssid const char psk Python...

Page 173: ...pecific parameters Out errNo errorCode JSON Method method com attocube system network discard params Result errNo C DLL call int system_network_discard int deviceHandle Python dev network discard Matl...

Page 174: ...Method method com attocube system network getDefaultGateway params Result errNo Default C DLL call int system_network_getDefaultGateway int deviceHandle char Default int size0 Python Default dev netwo...

Page 175: ...DNS resolver JSON Method method com attocube system network getDnsResolver params priority Result errNo IP C DLL call int system_network_getDnsResolver int deviceHandle int priority char IP int size0...

Page 176: ...sable JSON Method method com attocube system network getEnableDhcpClient params Result errNo value_boolean1 C DLL call int system_network_getEnableDhcpClient int deviceHandle bool value_boolean1 Pytho...

Page 177: ...r disable JSON Method method com attocube system network getEnableDhcpServer params Result errNo value_boolean1 C DLL call int system_network_getEnableDhcpServer int deviceHandle bool value_boolean1 P...

Page 178: ...ddress as string JSON Method method com attocube system network getIpAddress params Result errNo IP C DLL call int system_network_getIpAddress int deviceHandle char IP int size0 Python IP dev network...

Page 179: ...g empty for no proxy JSON Method method com attocube system network getProxyServer params Result errNo Proxy C DLL call int system_network_getProxyServer int deviceHandle char Proxy int size0 Python P...

Page 180: ...o errorCode IP address as string JSON Method method com attocube system network getRealIpAddress params Result errNo IP C DLL call int system_network_getRealIpAddress int deviceHandle char IP int size...

Page 181: ...k as string JSON Method method com attocube system network getSubnetMask params Result errNo Subnet C DLL call int system_network_getSubnetMask int deviceHandle char Subnet int size0 Python Subnet dev...

Page 182: ...mode 0 Access point 1 Wifi client JSON Method method com attocube system network getWifiMode params Result errNo mode C DLL call int system_network_getWifiMode int deviceHandle int mode Python mode de...

Page 183: ...errNo errorCode psk Pre shared key JSON Method method com attocube system network getWifiPassphrase params Result errNo psk C DLL call int system_network_getWifiPassphrase int deviceHandle char psk in...

Page 184: ...if interface is present JSON Method method com attocube system network getWifiPresent params Result errNo True C DLL call int system_network_getWifiPresent int deviceHandle bool True Python True dev n...

Page 185: ...arameters Out errNo errorCode SSID SSID JSON Method method com attocube system network getWifiSSID params Result errNo SSID C DLL call int system_network_getWifiSSID int deviceHandle char SSID int siz...

Page 186: ...JSON Method method com attocube system network setDefaultGateway params gateway Result errNo C DLL call int system_network_setDefaultGateway int deviceHandle const char gateway Python dev network set...

Page 187: ...rCode JSON Method method com attocube system network setDnsResolver params priority resolver Result errNo C DLL call int system_network_setDnsResolver int deviceHandle int priority const char resolver...

Page 188: ...rNo errorCode JSON Method method com attocube system network setEnableDhcpClient params enable Result errNo C DLL call int system_network_setEnableDhcpClient int deviceHandle bool enable Python dev ne...

Page 189: ...t errNo errorCode JSON Method method com attocube system network setEnableDhcpServer params enable Result errNo C DLL call int system_network_setEnableDhcpServer int deviceHandle bool enable Python de...

Page 190: ...rorCode JSON Method method com attocube system network setIpAddress params address Result errNo C DLL call int system_network_setIpAddress int deviceHandle const char address Python dev network setIpA...

Page 191: ...Code JSON Method method com attocube system network setProxyServer params proxyServer Result errNo C DLL call int system_network_setProxyServer int deviceHandle const char proxyServer Python dev netwo...

Page 192: ...orCode JSON Method method com attocube system network setSubnetMask params netmask Result errNo C DLL call int system_network_setSubnetMask int deviceHandle const char netmask Python dev network setSu...

Page 193: ...t 1 Wifi client Out errNo errorCode JSON Method method com attocube system network setWifiMode params mode Result errNo C DLL call int system_network_setWifiMode int deviceHandle int mode Python dev n...

Page 194: ...ared key Out errNo errorCode JSON Method method com attocube system network setWifiPassphrase params psk Result errNo C DLL call int system_network_setWifiPassphrase int deviceHandle const char psk Py...

Page 195: ...ameters In ssid Out errNo errorCode JSON Method method com attocube system network setWifiSSID params ssid Result errNo C DLL call int system_network_setWifiSSID int deviceHandle const char ssid Pytho...

Page 196: ...tion specific parameters Out errNo errorCode JSON Method method com attocube system network verify params Result errNo C DLL call int system_network_verify int deviceHandle Python dev network verify M...

Page 197: ...specific parameters Out errNo errorCode JSON Method method com attocube system rebootSystem params Result errNo C DLL call int system_rebootSystem int deviceHandle Python dev system_service rebootSyst...

Page 198: ...e Out errNo errorCode JSON Method method com attocube system setDeviceName params name Result errNo C DLL call int system_setDeviceName int deviceHandle const char name Python dev system_service setDe...

Page 199: ...nt JSON Method method com attocube system update getLicenseUpdateProgress params Result errNo value_int1 C DLL call int system_update_getLicenseUpdateProgress int deviceHandle int value_int1 Python va...

Page 200: ...JSON Method method com attocube system update getSwUpdateProgress params Result errNo value_int1 C DLL call int system_update_getSwUpdateProgress int deviceHandle int value_int1 Python value_int1 dev...

Page 201: ...on specific parameters Out errNo errorCode JSON Method method com attocube system update licenseUpdateBase64 params Result errNo C DLL call int system_update_licenseUpdateBase64 int deviceHandle Pytho...

Page 202: ...c parameters Out errNo errorCode JSON Method method com attocube system update softwareUpdateBase64 params Result errNo C DLL call int system_update_softwareUpdateBase64 int deviceHandle Python dev up...

Page 203: ...ethod method com attocube system update uploadLicenseBase64 params offset b64Data Result errNo C DLL call int system_update_uploadLicenseBase64 int deviceHandle int offset const char b64Data Python de...

Page 204: ...ttocube system update uploadSoftwareImageBase64 params offset b64Data Result errNo C DLL call int system_update_uploadSoftwareImageBase64 int deviceHandle int offset const char b64Data Python dev upda...

Page 205: ...ny Phone 49 89 420 797 0 E Mail info attocube com www attocube com For technical queries contact support attocube com Regional US Sales Representatives West Coast Arcadia CA Phone 1 510 631 2154 South...

Search results

Summary of Contents for attocube AMC100

Reviews:

Related manuals for attocube AMC100

Brands by name

Popular brands

Wittenstein attocube AMC100, Interface Manual

Search results

Summary of Contents for attocube AMC100

Reviews:

Related manuals for attocube AMC100

Brands by name

Popular brands