Wittenstein attocube AMC100 Interface Manual
  1. Manuals
  2. Brands
  3. Wittenstein Manuals
  4. Controller
  5. attocube AMC100
  6. Interface manual

Wittenstein attocube AMC100 Interface Manual

Hide thumbs Also See for attocube AMC100:
Table of Contents

Advertisement

Quick Links

Interface Manual
AMC100 & AMC300

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the attocube AMC100 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Wittenstein attocube AMC100

Summary of Contents for Wittenstein attocube AMC100

  • Page 1 Interface Manual AMC100 & AMC300...
  • Page 2 Modified: 02/2021 Products: AMC100 | AMC300 | attoDISCOVERY Software | AMC Webserver 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. ATTENTION: Specifications and technical data are subject to change without notice.

  • Page 4: Table Of Contents

    Table of Contents Page 1 Table of Contents 1 System Integration ......................... 2 1.1 Connecting to Third Party Hardware ................2 1.1.1 Cabling Restrictions .................... 2 1.1.2 Pin Assignments ....................2 2 Software communication & interfaces .................. 3 2.1 Introduction ........................3 2.1.1 Web Interface.....................

  • Page 5: System Integration

    Page 2 Table of Contents System Integration The AMC100 and the AMC300 can be integrated with external systems or devices by combining it with third party hardware establishing incoming and outgoing trigger connections (/IO upgrade required) controlling it with individual software interfaces Connecting to Third Party Hardware CAUTION General hazard!

  • Page 6: Software Communication & Interfaces

    Software communication & interfaces Page 3 Software communication & interfaces You can integrate your attocube Device into complex automated processes via individual software interfaces. Attocube provides APIs for the programming languages C, C#, LabVIEW, Python & Matlab as well as short programming examples to get you started. The following sections provide information on methods, commands and parameters to be used for calling up device functions with the respective language.

  • Page 7: Labview Vis

    Page 4 Table of Contents LabVIEW VIs 2.1.4 We offer ready-made VIs to have a fast and easy implementation in National Instrument’s LabVIEW environment. Matlab Library 2.1.5 Based on the JSON interface, we offer ready-made Matlab functios to have a fast and easy implementation in Mathwork’s Matlab environment.

  • Page 8: Overview And Implementation Of The Apis

    Software communication & interfaces Page 5 Overview and implementation of the APIs JSON-RPC (JRPC2.0) 2.2.1 Your attocube Device allows platform-independent communication using JSON-RPC via TCP/IP. When using JSON-RPC, the following conventions apply. Transport protocols Uses communication port 9090. Calling a JSON RPC A JSON RPC method is called by sending a message to the device.

  • Page 9: C Library

    Page 6 Table of Contents Open a Telnet connection with PuTTY. Sending Json-Rpc commands in the command line interface. C Library 2.2.2 The C API is provided to integrate the Device with all its functionality within your C programs. Overview The C API contains of following files: Standard C API: ...
  • Page 10 Software communication & interfaces Page 7 Using the .dll’s with Note that if you want to use the .dlls within x64 based systems different systems outside the framework of Visual C, you might need to convert the library into a static .a format. Establishing a To connect to a device, please use (part of attocubeJSONCall.h): connection...

  • Page 11: C# Library

    Page 8 Table of Contents /**< IP address of the device char modelName[32]; /**< Type of the device char serialNumber[32]; /**< Serial number of the device char deviceName[32]; /**< Friendly name assigned to the device */ char macAddress[32]; /**< MAC address of the device bool locked;...

  • Page 12: Labview

    Software communication & interfaces Page 9 public void Connect(string ipAddress, int port) The device handle is the reference to the connection to the device and is input to all other device functions that are following. To close the connection, please use: public void Disconnect() Both functions are included in the API and part of the device class...
  • Page 13 Page 10 Table of Contents Implementation To reduce complexity and external dependencies all TCP/IP calls have been implemented with native LabVIEW TCP/IP elements. For older LabVIEW Versions where there is no native TCP/IP support, DLL based VIs have been created taking care of the TCP/IP communication.

  • Page 14: Matlab

    Software communication & interfaces Page 11 Matlab 2.2.5 The Matlab API is provided to integrate the Device with all its functionality within your Matlab scripts. Establing a To connect to an device, please use: connection [success, DeviceHandle] = connect(IPAddress, port) The device handle is the reference to the connection to the device and is input to all other device functions that are following.
  • Page 15 Page 12 Table of Contents Discovering devices The discovery function can be used: within the same It searches your network for available devices and returns a list of network properties. This is done by an SSDP broadcast. If no devices are found, please check the device connection via TCP/IP (e.g.

  • Page 16: Error Handling

    Software communication & interfaces Page 13 Error handling C# error handling 2.3.1 Introduction The error handling in C# is realized with exceptions not by error numbers. Errors can be caught using a try-catch statement. To include the device specific exceptions, the catch clause will need the AttocubeAPIException as argument.

  • Page 17: Labview Error Handling

    Page 14 Table of Contents LabVIEW error handling 2.3.3 Introduction The error handling in LabVIEW is realized by using an error message variable which should be looped through all VIs. Therefore, every VI provides an error in and error out connector. Note that we divide the error variable in error messages and “real”...

  • Page 18: Functions

    Functions Page 15 Functions Access getLockStatus This function returns if the device is locked and if the current client is authorized to use the device. Function specific parameters errNo errorCode locked Is the device locked? authorized Is the client authorized? JSON Method method: getLockStatus params: []...
  • Page 19 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)
  • Page 20 Functions Page 17 lock This function locks the device with a password, so the calling of functions is only possible with this password. The locking IP is automatically added to the devices which can access functions Function specific parameters password string the password to be set errNo errorCode...
  • Page 21 Page 18 Table of Contents unlock This function unlocks the device, so it will not be necessary to execute the grantAccess function to run any function Function specific parameters password string the current password errNo errorCode JSON Method method: unlock params: [password] Result: [errNo] C-DLL call...

  • Page 22: Amcids

    Functions Page 19 Amcids getLowerSoftLimit Gets the lower boundary of the soft limit protection. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters axis Axis of the AMC to get the soft limit status from...
  • Page 23 Page 20 Table of Contents getSoftLimitEnabled Gets whether the soft limit protection is enabled. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters axis Axis of the AMC to get the soft limit status from...
  • Page 24 Functions Page 21 getSoftLimitReached Gets whether the current position is out of the soft limit boundaries. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters axis Axis of the AMC to get the soft limit status from...
  • Page 25 Page 22 Table of Contents getUpperSoftLimit Gets the upper lower boundary of the soft limit protection. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters axis Axis of the AMC to get the soft limit status from...
  • Page 26 Functions Page 23 resetIdsAxis Resets the position value to zero of a specific measurement axis. Use this for positioners with an IDS as sensor. This method does not work for NUM and RES sensors. Use com.attocube.amc.control.resetAxis instead. Function specific parameters axis Axis of the IDS to reset the position int32...
  • Page 27 Page 24 Table of Contents setLowerSoftLimit Sets the lower boundary of the soft limit protection in pm. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters Axis of the AMC where the soft limit should be axis...
  • Page 28 Functions Page 25 setSoftLimitEnabled Enables/disables the soft limit protection. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters Axis of the AMC where the soft limit should be axis changed...
  • Page 29 Page 26 Table of Contents setUpperSoftLimit Sets the upper boundary of the soft limit protection in pm. This protection is needed if the IDS working range is smaller than the positioners travel range. It is no hard limit, so, it is possible to overshoot it! Function specific parameters Axis of the AMC where the soft limit should be axis...

  • Page 30: Control

    Functions Page 27 Control MultiAxisPositioning Simultaneously set 3 axes positions and get positions to minimize network latency Function specific parameters set1 axis1 otherwise pos1 target is ignored set2 axis2 otherwise pos2 target is ignored set3 axis3 otherwise pos3 target is ignored target1 target position of axis 1 target2...
  • Page 31 Page 28 Table of Contents params: [set1, set2, set3, target1, target2, target3] Result: [errNo, ref1, ref2, ref3, refpos1, refpos2, refpos3, pos1, pos2, pos3] C-DLL call int AMC_control_MultiAxisPositioning(int deviceHandle, bool set1, bool set2, bool set3, int target1, int target2, int target3, bool* ref1, bool* ref2, bool* ref3, int* refpos1, int* refpos2, int* refpos3, int* pos1, int* pos2, int* pos3) Python ref1, ref2, ref3, refpos1, refpos2, refpos3, pos1, pos2, pos3 =...
  • Page 32 Functions Page 29 getActorName This function gets the name of the positioner of the selected axis. Function specific parameters axis [0|1|2] errNo errNo actor_name 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) Python actor_name = [dev].control.getActorName(axis)
  • Page 33 Page 30 Table of Contents getActorParametersActorName Control the actors parameter: actor name Function specific parameters axis [0|1|2] errNo errNo actorname actorname JSON Method method: com.attocube.amc.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].control.getActorParametersActorName(axis) Matlab...
  • Page 34 Functions Page 31 getActorSensitivity Get the setting for the actor parameter sensitivity Function specific parameters axis [0|1|2] errNo errNo sensitivity sensitivity JSON Method 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 sensitivity = [dev].control.getActorSensitivity(axis) Matlab [sensitivity] = control_getActorSensitivity(axis)
  • Page 35 Page 32 Table of Contents getActorType This function gets the type of the positioner of the selected axis. Function specific parameters axis [0|1|2] errNo errNo actor_type 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* actor_type) Python...
  • Page 36 Functions Page 33 getAutoMeasure This function returns if the automeasurement on axis enable is enabled Function specific parameters axis [0|1|2] errNo errNo true: enable automeasurement, false: disable enable automeasurement JSON Method method: com.attocube.amc.control.getAutoMeasure params: [axis] Result: [errNo, enable] C-DLL call int AMC_control_getAutoMeasure(int deviceHandle, int axis, bool* enable) Python enable = [dev].control.getAutoMeasure(axis)
  • Page 37 Page 34 Table of Contents getControlAmplitude This function gets the amplitude of the actuator signal of the selected axis. Function specific parameters axis [0|1|2] errNo errNo amplitude 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) Python...
  • Page 38 Functions Page 35 getControlAutoReset This function resets the position every time the reference position is detected. Function specific parameters axis [0|1|2] errNo errNo enabled 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 enabled = [dev].control.getControlAutoReset(axis)
  • Page 39 Page 36 Table of Contents getControlFixOutputVoltage This function gets the DC level output of the selected axis. Function specific parameters axis [0|1|2] errNo errNo amplitude_mv in mV JSON Method method: com.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 amplitude_mv = [dev].control.getControlFixOutputVoltage(axis)
  • Page 40 Functions Page 37 getControlFrequency This function gets the frequency of the actuator signal of the selected axis. Function specific parameters axis [0|1|2] errNo errNo frequency 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 frequency = [dev].control.getControlFrequency(axis)
  • Page 41 Page 38 Table of Contents getControlMove This function gets the approach of the selected axis’ positioner to the target position. Function specific parameters axis [0|1|2] errNo errNo boolean true: closed loop control enabled, false: enable closed loop control disabled JSON Method method: com.attocube.amc.control.getControlMove params: [axis] Result: [errNo, enable]...
  • Page 42 Functions Page 39 getControlOutput This function gets the status of the output relays of the selected axis. Function specific parameters axis [0|1|2] errNo errNo enabled power status (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* enabled) Python...
  • Page 43 Page 40 Table of Contents getControlReferenceAutoUpdate This function gets the status of whether the reference position is updated when the reference mark is hit. When this function is disabled, the reference marking will be considered only the first time and after then ignored. Function specific parameters axis [0|1|2]...
  • Page 44 Functions Page 41 getControlTargetRange This function gets the range around the target position in which the flag "In Target Range" becomes active. Function specific parameters axis [0|1|2] errNo errNo targetrange 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* targetrange)
  • Page 45 Page 42 Table of Contents getCrosstalkThreshold This function gets the threshold range and slip phase time which is used while moving another axis Function specific parameters axis [0|1|2] errNo errNo range in pm after slip phase which is waited until the controller is time acting again in microseconds JSON Method...
  • Page 46 Functions Page 43 getCurrentOutputVoltage This function gets the current Voltage which is applied to the Piezo Function specific parameters axis [0|1|2] errNo errNo amplitude in mV JSON Method 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 amplitude = [dev].control.getCurrentOutputVoltage(axis)
  • Page 47 Page 44 Table of Contents getExternalSensor This function gets whether the sensor source of closed loop is IDS It is only available when the feature AMC/IDS closed loop has been activated Function specific parameters axis [0|1|2] errNo errNo enabled enabled JSON Method method: com.attocube.amc.control.getExternalSensor params: [axis]...
  • Page 48 Functions Page 45 getMotionControlThreshold This function gets the threshold range within the closed-loop controlled movement stops to regulate. Function specific parameters axis [0|1|2] errNo errNo range 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) Python range = [dev].control.getMotionControlThreshold(axis)
  • Page 49 Page 46 Table of Contents getPositionsAndVoltages Simultaneously get 3 axes positions as well as the DC offset to maximize sampling rate over network Function specific parameters errNo errNo pos1 position of axis 1 pos2 position of axis 2 pos3 position of axis 3 val1 dc voltage of of axis 1 in mV val2...
  • Page 50 Functions Page 47 getReferencePosition This function gets the reference position of the selected axis. Function specific parameters axis [0|1|2] errNo errNo position: For linear type actors the position is position defined in nm for goniometer an rotator type actors it is µ°. JSON Method method: com.attocube.amc.control.getReferencePosition params: [axis]...
  • Page 51 Page 48 Table of Contents getSensorDirection This function gets whether the IDS sensor source of closed loop is inverted It is only available when the feature AMC/IDS closed loop has been activated Function specific parameters axis [0|1|2] errNo errNo inverted boolen JSON Method method: com.attocube.amc.control.getSensorDirection...
  • Page 52 Functions Page 49 getSensorEnabled Get sensot power supply status Function specific parameters axis [0|1|2] errNo errNo value true if enabled, false otherwise 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].control.getSensorEnabled(axis) Matlab...
  • Page 53 Page 50 Table of Contents getStatusMovingAllAxes Get Status of all axes, see getStatusMoving for coding of the values Function specific parameters errNo errNo moving1 status of axis 1 moving2 status of axis 2 moving3 status of axis 3 JSON Method method: com.attocube.amc.control.getStatusMovingAllAxes params: [] Result: [errNo, moving1, moving2, moving3]...
  • Page 54 Functions Page 51 searchReferencePosition This function searches for the reference position of the selected axis. Function specific parameters axis [0|1|2] errNo 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.searchReferencePosition(axis) Matlab [] = control_searchReferencePosition(axis) void value = [Device].Control_SearchReferencePosition(int axis) LabVIEW...
  • Page 55 Page 52 Table of Contents setActorParametersByName This function sets the name for the positioner on the selected axis. The possible names can be retrieved by executing getPositionersList Function specific parameters axis [0|1|2] actorname name of the actor errNo errNo JSON Method method: com.attocube.amc.control.setActorParametersByName params: [axis, actorname] Result: [errNo]...
  • Page 56 Functions Page 53 setActorParametersJson Select and override a positioner out of the Current default list only override given parameters set others default Function specific parameters axis [0|1|2] json_dict dict with override params 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, const...
  • Page 57 Page 54 Table of Contents setActorSensitivity Control the actor parameter closed loop sensitivity Function specific parameters axis [0|1|2] sensitivity errNo errNo JSON Method method: 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.setActorSensitivity(axis, sensitivity) Matlab [] = control_setActorSensitivity(axis, sensitivity)
  • Page 58 Functions Page 55 setAutoMeasure This function enables/disables the automatic C/R measurement on axis enable Function specific parameters axis [0|1|2] true: enable automeasurement, false: disable enable automeasurement 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, bool enable) Python [dev].control.setAutoMeasure(axis, enable) Matlab...
  • Page 59 Page 56 Table of Contents setControlAmplitude This function sets the amplitude of the actuator signal of the selected axis. Function specific parameters axis [0|1|2] amplitude in mV errNo errNo 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...
  • Page 60 Functions Page 57 setControlAutoReset This function resets the position every time the reference position is detected. Function specific parameters axis [0|1|2] enable boolean errNo 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].control.setControlAutoReset(axis, enable)
  • Page 61 Page 58 Table of Contents setControlFixOutputVoltage This function sets the DC level output of the selected axis. ( must perform applyControlFixOutputVoltage to apply on the positioner) Function specific parameters axis [0|1|2] amplitude_mv in mV errNo errNo JSON Method method: com.attocube.amc.control.setControlFixOutputVoltage params: [axis, amplitude_mv] Result: [errNo] C-DLL call...
  • Page 62 Functions Page 59 setControlFrequency This function sets the frequency of the actuator signal of the selected axis. Note: Approximate the slewrate of the motion controller according to Input Frequency Function specific parameters axis [0|1|2] frequency in mHz errNo errNo JSON Method method: com.attocube.amc.control.setControlFrequency params: [axis, frequency] Result: [errNo]...
  • Page 63 Page 60 Table of Contents setControlMove This function sets the approach of the selected axis’ positioner to the target position. Function specific parameters axis [0|1|2] boolean true: eanble the approach , false: disable the enable approach errNo errNo JSON Method method: com.attocube.amc.control.setControlMove params: [axis, enable] Result: [errNo]...
  • Page 64 Functions Page 61 setControlOutput This function sets the status of the output relays of the selected axis. Enable only if cable is connected and FlyBack is enabled use a PWM startup of 1sec Function specific parameters axis [0|1|2] enable true: enable drives, false: disable drives errNo errNo JSON Method...
  • Page 65 Page 62 Table of Contents setControlReferenceAutoUpdate This function sets the status of whether the reference position is updated when the reference mark is hit. When this function is disabled, the reference marking will be considered only the first time and after then ignored. Function specific parameters axis [0|1|2]...
  • Page 66 Functions Page 63 setControlTargetRange This function sets the range around the target position in which the flag "In Target Range" (see VIII.7.a) becomes active. Function specific parameters axis [0|1|2] range in nm 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 range)
  • Page 67 Page 64 Table of Contents setCrosstalkThreshold This function sets the threshold range and slip phase time which is used while moving another axis Function specific parameters axis [0|1|2] threshold in pm time after slip phase which is waited until the slipphasetime controller is acting again in microseconds errNo...
  • Page 68 Functions Page 65 setExternalSensor This function sets the sensor source of closed loop to the IDS when enabled. Otherwise the normal AMC Sensor depending on the configuration (e.g. NUM or RES) is used It is only available when the feature AMC/IDS closed loop has been activated Function specific parameters axis...
  • Page 69 Page 66 Table of Contents setMotionControlThreshold This function sets the threshold range within the closed-loop controlled movement stops to regulate. Default depends on connected sensor type Function specific parameters axis [0|1|2] threshold in pm errNo errNo JSON Method method: com.attocube.amc.control.setMotionControlThreshold params: [axis, threshold] Result: [errNo] C-DLL call...
  • Page 70 Functions Page 67 setReset This function resets the actual position of the selected axis given by the NUM sensor to zero and marks the reference position as invalid. It does not work for RES positioners and positions read by IDS. For IDS, use com.attocube.ids.displacement.resetAxis() or com.attocube.amc.amcids.resetIdsAxis() instead.
  • Page 71 Page 68 Table of Contents setSensorDirection This function sets the IDS sensor source of closed loop to inverted when true. It is only available when the feature AMC/IDS closed loop has been activated Function specific parameters axis [0|1|2] inverted errNo errNo JSON Method method: com.attocube.amc.control.setSensorDirection...
  • Page 72 Functions Page 69 setSensorEnabled Set sensor power supply status, can be switched off to save heat generated by sensor [NUM or RES] Positions retrieved will be invalid when activating this, so closed-loop control should be switched off beforehand Function specific parameters axis [0|1|2] value...

  • Page 73: Description

    Page 70 Table of Contents Description checkChassisNbr Get Chassis and Slot Number, only works when AMC is within a Rack Function specific parameters errNo errorCode slotNbr slotNbr chassisNbr chassisNbr 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* chassisNbr) Python...
  • Page 74 Functions Page 71 getDeviceType This function gets the device type based on its EEPROM configuration. Function specific parameters errNo errNo Device name (AMC100, AMC300) with attached devicetype 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, char* devicetype, int size0)
  • Page 75 Page 72 Table of Contents getFeaturesActivated Get the activated features and return as a string Function specific parameters errNo errNo activated on device concatenated by comma e.g. features Closed loop Operation, 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, char* features,...
  • Page 76 Functions Page 73 getPositionersList This function reads the actor names that can be connected to the device. Function specific parameters errNo errNo PositionersList PositionersList JSON Method method: com.attocube.amc.description.getPositionersList params: [] Result: [errNo, PositionersList] C-DLL call int AMC_description_getPositionersList(int deviceHandle, char* PositionersList, int size0) Python PositionersList = [dev].description.getPositionersList() Matlab...

  • Page 77: Diagnostic

    Page 74 Table of Contents Diagnostic getDiagnosticPower Returns the current power consumption Function specific parameters axis [0|1|2] errNo errNo power power 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].diagnostic.getDiagnosticPower(axis) Matlab [power] = diagnostic_getDiagnosticPower(axis)
  • Page 78 Functions Page 75 getDiagnosticResults Returns the results of the last diagnostic run and an error, if there was no run, it is currently running or the run failed Function specific parameters axis [0|1|2] errNo errNo capacity in nF resistance in Ohm JSON Method method: com.attocube.amc.diagnostic.getDiagnosticResults params: [axis]...
  • Page 79 Page 76 Table of Contents getDiagnosticTemperature Returns the current axis temperature Function specific parameters axis [0|1|2] errNo errNo temperature temperature JSON Method method: com.attocube.amc.diagnostic.getDiagnosticTemperature params: [axis] Result: [errNo, temperature] C-DLL call int AMC_diagnostic_getDiagnosticTemperature(int deviceHandle, int axis, int* temperature) Python temperature = [dev].diagnostic.getDiagnosticTemperature(axis) Matlab [temperature] = diagnostic_getDiagnosticTemperature(axis) int value = [Device].Diagnostic_GetDiagnosticTemperature(int axis)
  • Page 80 Functions Page 77 startDiagnostic Start the diagnosis procedure for the given axis Function specific parameters axis [0|1|2] errNo 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.startDiagnostic(axis) Matlab [] = diagnostic_startDiagnostic(axis) void value = [Device].Diagnostic_StartDiagnostic(int axis) LabVIEW startDiagnostic.vi...
  • Page 81 Page 78 Table of Contents Move getControlContinuousBkwd This function gets the axis’ movement status in backward direction. Function specific parameters axis [0|1|2] errNo errNo true if movement backward is active , false enabled otherwise JSON Method method: com.attocube.amc.move.getControlContinuousBkwd params: [axis] Result: [errNo, enabled] C-DLL call int AMC_move_getControlContinuousBkwd(int deviceHandle, int axis, bool*...
  • Page 82 Functions Page 79 getControlContinuousFwd This function gets the axis’ movement status in positive direction. Function specific parameters axis [0|1|2] errNo errNo enabled true if movement Fwd is active, 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* enabled) Python...
  • Page 83 Page 80 Table of Contents getControlEotOutputDeactive This function gets the output applied to the selected axis on the end of travel. /PRO feature. Function specific parameters axis [0|1|2] errNo errNo If true, the output of the axis will be deactivated on enabled positive EOT detection.
  • Page 84 Functions Page 81 getControlTargetPosition This function gets the target position for the movement on the selected axis. Function specific parameters axis [0|1|2] errNo errNo defined in nm for goniometer an rotator type actors position it is µ°. JSON Method method: com.attocube.amc.move.getControlTargetPosition params: [axis] Result: [errNo, position] C-DLL call...
  • Page 85 Page 82 Table of Contents getGroundAxis Pull axis piezo drive to GND actively only in AMC300 Function specific parameters axis montion controler axis [0|1|2] 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* grounded) Python...
  • Page 86 Functions Page 83 getGroundAxisAutoOnTarget Pull axis piezo drive to GND if positioner is in ground target range ONLY DUMMY RIGHT NOW only in AMC300 Function specific parameters axis montion controler axis [0|1|2] errNo 0 or error value true or false JSON Method method: com.attocube.amc.move.getGroundAxisAutoOnTarget params: [axis]...
  • Page 87 Page 84 Table of Contents getGroundTargetRange Retrieves the range around the target position in which the auto grounding becomes active. only in AMC300 Function specific parameters axis [0|1|2] errNo 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* targetrange)
  • Page 88 Functions Page 85 getNSteps This function gets the number of Steps in desired direction. Function specific parameters axis [0|1|2] 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 nbrstep = [dev].move.getNSteps(axis) Matlab...
  • Page 89 Page 86 Table of Contents getPosition This function gets the current position of the positioner on the selected axis. The axis on the web application are indexed from 1 to 3 Function specific parameters axis [0|1|2] errNo errNo defined in nm for goniometer an rotator type actors position it is µ°.
  • Page 90 Functions Page 87 moveReference This function starts an approach to the reference position. A running motion command is aborted; closed loop moving is switched on. Requires a valid reference position. Function specific parameters axis [0|1|2] errNo errNo JSON Method method: com.attocube.amc.move.moveReference params: [axis] Result: [errNo] C-DLL call...
  • Page 91 Page 88 Table of Contents performNSteps Perform the OL command for N steps Function specific parameters axis [0|1|2] Selects the desired direction. False triggers a forward backward step, true a backward step 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 char*...
  • Page 92 Functions Page 89 setControlContinuousBkwd This function sets a continuous movement on the selected axis in backward direction. Function specific parameters axis [0|1|2] If enabled a present movement in the opposite enable direction is stopped. The parameter "false" stops all movement of the axis regardless its direction errNo errNo JSON Method...
  • Page 93 Page 90 Table of Contents setControlContinuousFwd This function sets a continuous movement on the selected axis in positive direction. Function specific parameters axis [0|1|2] If enabled a present movement in the opposite enable direction is stopped. The parameter "false" stops all movement of the axis regardless its direction.
  • Page 94 Functions Page 91 setControlEotOutputDeactive This function sets the output applied to the selected axis on the end of travel. Function specific parameters axis [0|1|2] if enabled, the output of the axis will be deactivated enable on positive EOT detection. errNo errNo JSON Method method: com.attocube.amc.move.setControlEotOutputDeactive...
  • Page 95 Page 92 Table of Contents setControlTargetPosition This function sets the target position for the movement on the selected axis. careful: the maximum positon in nm is 2**47/1000 Function specific parameters axis [0|1|2] absolute position : For linear type actors the position target is defined in nm for goniometer an rotator type actors it is µ°.
  • Page 96 Functions Page 93 setGroundAxis Pull axis piezo drive to GND actively only in AMC300 this is used in MIC-Mode Function specific parameters axis motion controler axis [0|1|2] enabled true or false 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 enabled)
  • Page 97 Page 94 Table of Contents setGroundAxisAutoOnTarget Pull axis piezo drive to GND if positioner is in ground target range ONLY DUMMY RIGHT NOW only in AMC300 this is used in MIC-Mode Function specific parameters axis montion controler axis [0|1|2] enabled true or false errNo 0 or error...
  • Page 98 Functions Page 95 setGroundTargetRange Set the range around the target position in which the auto grounding becomes active. only in AMC300 Function specific parameters axis [0|1|2] range in nm 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) Python...
  • Page 99 Page 96 Table of Contents setNSteps This function triggers n steps on the selected axis in desired direction. /PRO feature. Function specific parameters axis [0|1|2] Selects the desired direction. False triggers a forward backward step, true a backward step step number of step errNo errNo...
  • Page 100 Functions Page 97 setSingleStep This function triggers one step on the selected axis in desired direction. Function specific parameters axis [0|1|2] Selects the desired direction. False triggers a forward backward step, true a backward step errNo errNo JSON Method method: com.attocube.amc.move.setSingleStep params: [axis, backward] Result: [errNo] C-DLL call...
  • Page 101 Page 98 Table of Contents writeNSteps Sets the number of steps to perform on stepwise movement. /PRO feature. Function specific parameters axis [0|1|2] step number of step 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) Python [dev].move.writeNSteps(axis, step)
  • Page 102 Functions Page 99 getChainGain Get chain gain Function specific parameters axis number of axis errNo errNo gaincoeff 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].res.getChainGain(axis) Matlab [gaincoeff] = res_getChainGain(axis) int value = [Device].Res_GetChainGain(int axis)
  • Page 103 Page 100 Table of Contents getLinearization Gets wether linearization is enabled or not Function specific parameters axis [0|1|2] errNo errNo enabled 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 enabled = [dev].res.getLinearization(axis) Matlab...
  • Page 104 Functions Page 101 getLutSn get the identifier of the loaded lookuptable (will be empty if disabled) Function specific parameters axis [0|1|2] errNo errNo 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, int size0) Python value_string1 = [dev].res.getLutSn(axis)
  • Page 105 Page 102 Table of Contents getMode Get mode of RES application Function specific parameters 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() Matlab [mode] = res_getMode() int value = [Device].Res_GetMode() LabVIEW getMode.vi...
  • Page 106 Functions Page 103 setChainGain Set signal chain gain to control overall power Function specific parameters axis number of axis 0: 0dB ( power 600mVpkpk^2/R), 1 : -10 dB , 2 : -15 gainconfig dB , 3 : -20 dB errNo errNo JSON Method method: com.attocube.amc.res.setChainGain...
  • Page 107 Page 104 Table of Contents setConfigurationFile Load configuration file which either contains JSON parameters or the LUT file itself (as legacy support) Function specific parameters axis [0|1|2] content 1k * 24 bit string or JSON File errNo errNo JSON Method method: com.attocube.amc.res.setConfigurationFile params: [axis, content] Result: [errNo]...
  • Page 108 Functions Page 105 setLinearization Control if linearization is enabled or not Function specific parameters axis [0|1|2] enable boolean ( true: enable linearization) 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.setLinearization(axis, enable) Matlab...
  • Page 109 Page 106 Table of Contents setMode Get mode of RES application Function specific parameters 1: Individual mode with triple ortho frequency mode rejection method 2: Mic Mode with dual frequency rejection method errNo errNo JSON Method method: com.attocube.amc.res.setMode params: [mode] Result: [errNo] C-DLL call int AMC_res_setMode(int deviceHandle, int mode)

  • Page 110: Move 78 3.7 Res 99 3.8 Rotcomp

    Functions Page 107 Rotcomp getControlTargetRanges Checks if all three axis are in target range. Function specific parameters int32 errNo Error code, if there was an error, otherwise 0 for ok boolean in_target_range true all three axes are in target range, false at least one axis is not in target range JSON Method method: com.attocube.amc.rotcomp.getControlTargetRanges...
  • Page 111 Page 108 Table of Contents getEnabled Gets the enabled status of the rotation compensation Function specific parameters int32 errNo Error code, if there was an error, otherwise 0 for ok boolean enabled true Rotation compensation is enabled, false Rotation compensation is disabled JSON Method method: com.attocube.amc.rotcomp.getEnabled params: []...
  • Page 112 Functions Page 109 getLUT Gets the LUT file as JSON string Function specific parameters int32 errNo Error code, if there was an error, otherwise 0 for ok string JSON string of the LUT file for the rotation compensation JSON Method method: com.attocube.amc.rotcomp.getLUT params: [] Result: [errNo, lut]...
  • Page 113 Page 110 Table of Contents setEnabled Enables and disables the rotation compensation Function specific parameters true Rotation compensation is enabled, false enabled Rotation compensation is disabled int32 errNo Error code, if there was an error, otherwise 0 for ok JSON Method method: com.attocube.amc.rotcomp.setEnabled params: [enabled] Result: [errNo]...
  • Page 114 Functions Page 111 setLUT Sets the LUT file from a JSON string Function specific parameters JSON string of the LUT file for the rotation lut_string compensation int32 errNo Error code, if there was an error, otherwise 0 for ok JSON Method method: com.attocube.amc.rotcomp.setLUT params: [lut_string] Result: [errNo]...
  • Page 115 Page 112 Table of Contents updateOffsets Updates the start offsets of the axes Function specific parameters offset_axis0 Offset of axis 1 in [nm] offset_axis1 Offset of axis 2 in [nm] offset_axis2 Offset of axis 3 in [nm] int32 errNo Error code, if there was an error, otherwise 0 for ok JSON Method method: com.attocube.amc.rotcomp.updateOffsets params: [offset_axis0, offset_axis1, offset_axis2]...

  • Page 116: Rtin

    Functions Page 113 Rtin apply Apply all realtime input function Function specific parameters 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_apply() void value = [Device].Rtin_Apply() LabVIEW rtin_apply.vi...
  • Page 117 Page 114 Table of Contents discard Discard all values beting set and not yet applieds Function specific parameters 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() Matlab [] = rtin_discard() void value = [Device].Rtin_Discard() LabVIEW rtin_discard.vi...
  • Page 118 Functions Page 115 getControlAQuadBInResolution This function gets the AQuadB input resolution for setpoint parameter. Function specific parameters axis [0|1|2] errNo errNo resolution ion nm JSON Method method: com.attocube.amc.rtin.getControlAQuadBInResolution params: [axis] Result: [errNo, resolution] C-DLL call int AMC_rtin_getControlAQuadBInResolution(int deviceHandle, int axis, int* resolution) Python resolution = [dev].rtin.getControlAQuadBInResolution(axis)
  • Page 119 Page 116 Table of Contents getControlMoveGPIO This function gets the status for real time input on the selected axis in closed-loop mode. Function specific parameters axis [0|1|2] errNo errNo boolean true: approach enabled , false: approach enable disabled JSON Method method: com.attocube.amc.rtin.getControlMoveGPIO params: [axis] Result: [errNo, enable]...
  • Page 120 Functions Page 117 getGpioMode get the GPIO mode for Mic Mode feature Function specific parameters errNo errNo gpio_mode gpio_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 gpio_mode = [dev].rtin.getGpioMode() Matlab...
  • Page 121 Page 118 Table of Contents getNslMux get the axis the NSL multiplexer is set to Function specific parameters [0|1|2|3] 0: Off mux_mode 1: Axis 1 2: Axis 2 3: Axis 3 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...
  • Page 122 Functions Page 119 getRealTimeInChangePerPulse This function gets the change per pulse for the selected axis under real time input in the closed-loop mode. Function specific parameters axis [0|1|2] errNo errNo resolution to be added in current pos in nm JSON Method method: com.attocube.amc.rtin.getRealTimeInChangePerPulse params: [axis] Result: [errNo, resolution]...
  • Page 123 Page 120 Table of Contents getRealTimeInFeedbackLoopMode Get if the realtime function must operate in close loop operation or open loop operation Function specific parameters axis [0|1|2] errNo errNo mode 0: open loop, 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,...
  • Page 124 Functions Page 121 getRealTimeInMode This function sets or gets the real time input mode for the selected axis. Function specific parameters axis [0|1|2] errNo 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 mode = [dev].rtin.getRealTimeInMode(axis) Matlab...
  • Page 125 Page 122 Table of Contents getRealTimeInStepsPerPulse Get the change in step per pulse of the realtime input when trigger and stepper mode is used Function specific parameters axis [0|1|2] errNo errNo steps number of steps to applied JSON Method method: com.attocube.amc.rtin.getRealTimeInStepsPerPulse params: [axis] Result: [errNo, steps] C-DLL call...
  • Page 126 Functions Page 123 setControlAQuadBInResolution This function sets the AQuadB input resolution for setpoint parameter. Function specific parameters axis [0|1|2] resolution ion nm errNo errNo JSON Method method: com.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.setControlAQuadBInResolution(axis, resolution)
  • Page 127 Page 124 Table of Contents setControlMoveGPIO This function sets the status for real time input on the selected axis in closed-loop mode. Function specific parameters axis [0|1|2] boolean true: eanble the approach , false: disable the enable approach errNo errNo JSON Method method: com.attocube.amc.rtin.setControlMoveGPIO params: [axis, enable]...
  • Page 128 Functions Page 125 setGpioMode set the GPIO mode for Mic Mode feature Function specific parameters [0|1] gpio_mode 0: Standard GPIO 1: NSL-/Mic-Mode 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.setGpioMode(gpio_mode) Matlab [] = rtin_setGpioMode(gpio_mode)
  • Page 129 Page 126 Table of Contents setNslMux set the axis the NSL multiplexer is set to Function specific parameters [0|1|2|3] 0: Off mux_mode 1: Axis 1 2: Axis 2 3: Axis 3 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...
  • Page 130 Functions Page 127 setRealTimeInChangePerPulse This function sets the change per pulse for the selected axis under real time input in the closed-loop mode. only used in closed loop operation Function specific parameters axis [0|1|2] delta to be added to current position in nm errNo errNo JSON Method...
  • Page 131 Page 128 Table of Contents setRealTimeInFeedbackLoopMode Set if the realtime function must operate in close loop operation or open loop operation Function specific parameters axis [0|1|2] mode 0: open loop, 1 : close-loop errNo 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,...
  • Page 132 Functions Page 129 setRealTimeInMode This function sets the real time input mode for the selected axis. Function specific parameters axis [0|1|2] mode see `RT_IN_MODES` @see realtime 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 [dev].rtin.setRealTimeInMode(axis, mode) Matlab...
  • Page 133 Page 130 Table of Contents setRealTimeInStepsPerPulse Set the change in step per pulse of the realtime input when trigger and stepper mode is used only used in open loop operation Function specific parameters axis [0|1|2] steps number of steps to applied errNo errNo JSON Method...
  • Page 134 Functions Page 131 Rtout 3.10 apply Apply for all rtout function Function specific parameters 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_apply() void value = [Device].Rtout_Apply() LabVIEW rtout_apply.vi...
  • Page 135 Page 132 Table of Contents applyAxis Apply for rtout function of specific axis Function specific parameters axis [0|1|2] 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(axis) Matlab [] = rtout_applyAxis(axis) void value = [Device].Rtout_ApplyAxis(int axis) LabVIEW rtout_applyAxis.vi...
  • Page 136 Functions Page 133 discard Discard all rtout value set by the set function(not applied yet) Function specific parameters 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() Matlab [] = rtout_discard() void value = [Device].Rtout_Discard() LabVIEW rtout_discard.vi...
  • Page 137 Page 134 Table of Contents discardAxis Discard rtout value of specific axis set by the set function(not applied yet) Function specific parameters axis [0|1|2] 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].rtout.discardAxis(axis) Matlab...
  • Page 138 Functions Page 135 discardSignalMode Discard value set by setSignalMode Function specific parameters 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 [] = rtout_discardSignalMode() void value = [Device].Rtout_DiscardSignalMode() LabVIEW rtout_discardSignalMode.vi...
  • Page 139 Page 136 Table of Contents getControlAQuadBOut This function gets if of AQuadB output for position indication is enabled Function specific parameters axis [0|1|2] errNo errNo enabled 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 enabled = [dev].rtout.getControlAQuadBOut(axis)
  • Page 140 Functions Page 137 getControlAQuadBOutClock This function gets the clock for AQuadB output. Function specific parameters axis [0|1|2] errNo errNo Clock in multiples of 20ns. Minimum 2 (40ns), clock_in_ns maximum 65535 (1,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_in_ns)
  • Page 141 Page 138 Table of Contents getControlAQuadBOutResolution This function gets the AQuadB output resolution for position indication. Function specific parameters axis [0|1|2] errNo errNo resolution in nm JSON Method method: com.attocube.amc.rtout.getControlAQuadBOutResolution params: [axis] Result: [errNo, resolution] C-DLL call int AMC_rtout_getControlAQuadBOutResolution(int deviceHandle, int axis, int* resolution) Python resolution = [dev].rtout.getControlAQuadBOutResolution(axis)
  • Page 142 Functions Page 139 getMode Get Mode Function specific parameters axis [0|1|2] errNo errNo mode 0: Off, 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(axis) Matlab [mode] = rtout_getMode(axis) int value = [Device].Rtout_GetMode(int axis)
  • Page 143 Page 140 Table of Contents getSignalMode This function gets the real time output mode for the selected axis. Function specific parameters 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 mode = [dev].rtout.getSignalMode() Matlab...
  • Page 144 Functions Page 141 getTriggerConfig Get the real time output trigger config Function specific parameters axis [0|1|2] errNo errNo higher upper limit in nm / µdeg lower lower limit in nm / µdeg epsilon hysteresis in nm / µdeg polarity 0: active high, 1: active low JSON Method method: com.attocube.amc.rtout.getTriggerConfig params: [axis]...
  • Page 145 Page 142 Table of Contents setControlAQuadBOutClock This function sets the clock for AQuadB output. Function specific parameters axis [0|1|2] Clock in multiples of 20ns. Minimum 2 (40ns), clock maximum 65535 (1,310700ms) 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...
  • Page 146 Functions Page 143 setControlAQuadBOutResolution This function sets the AQuadB output resolution for position indication. Function specific parameters axis [0|1|2] resolution in nm errNo errNo JSON Method method: com.attocube.amc.rtout.setControlAQuadBOutResolution params: [axis, resolution] Result: [errNo] C-DLL call int AMC_rtout_setControlAQuadBOutResolution(int deviceHandle, int axis, int resolution) Python [dev].rtout.setControlAQuadBOutResolution(axis, resolution)
  • Page 147 Page 144 Table of Contents setMode Set the real time output signal mode Function specific parameters axis [0|1|2] mode 0: Off, 1: AquadB, 2: Trigger 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.setMode(axis, mode) Matlab...
  • Page 148 Functions Page 145 setSignalMode This function sets the real time output mode for the selected axis. Function specific parameters mode 0: TTL, 1: LVDS 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.setSignalMode(mode) Matlab...
  • Page 149 Page 146 Table of Contents setTriggerConfig Control the real time output trigger config Function specific parameters axis [0|1|2] higher upper limit in nm / µdeg lower lower limit in nm / µdeg epsilon hysteresis in nm / µdeg polarity 0: active high, 1: active low errNo errNo JSON Method...

  • Page 150: Status

    Functions Page 147 Status 3.11 getFullCombinedStatus Get the full combined status of a positioner axis and return the status as a string (to be used in the Webapplication) Function specific parameters axis [0|1|2] errNo errNo string can be "moving","in target range", "backward value_string1 limit reached", "forward limit reached", "positioner not connected", "output not enabled"...
  • Page 151 Page 148 Table of Contents getOlStatus Get the Feedback status of the positioner Function specific parameters axis [0|1|2] errNo errNo as integer 0: NUM Positioner connected 1: OL sensorstatus positioner connected 2: No positioner connected , 3: RES positione connected JSON Method method: com.attocube.amc.status.getOlStatus params: [axis]...
  • Page 152 Functions Page 149 getStatusConnected This function gets information about the connection status of the selected axis’ positioner. Function specific parameters axis [0|1|2] errNo errNo connected 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, bool* connected)
  • Page 153 Page 150 Table of Contents getStatusEot Retrieves the status of the end of travel (EOT) detection in backward direction or in forward direction. Function specific parameters axis [0|1|2] errNo errNo detected true when EoT in either direction was detected JSON Method method: com.attocube.amc.status.getStatusEot params: [axis] Result: [errNo, detected]...
  • Page 154 Functions Page 151 getStatusEotBkwd This function gets the status of the end of travel detection on the selected axis in backward direction. Function specific parameters axis [0|1|2] errNo 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 axis, bool*...
  • Page 155 Page 152 Table of Contents getStatusEotFwd This function gets the status of the end of travel detection on the selected axis in forward direction. Function specific parameters axis [0|1|2] errNo errNo detected true when EoT was detected JSON Method method: com.attocube.amc.status.getStatusEotFwd params: [axis] Result: [errNo, detected] C-DLL call...
  • Page 156 Functions Page 153 getStatusMoving This function gets information about the status of the stage output. Function specific parameters axis [0|1|2] errNo errNo 0: Idle, i.e. within the noise range of the sensor, 1: Moving, i.e the actor is actively driven by the output stage either for closed-loop approach or status continous/single stepping and the output is active.
  • Page 157 Page 154 Table of Contents getStatusReference This function gets information about the status of the reference position. Function specific parameters axis [0|1|2] errNo errNo valid 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* valid) Python...
  • Page 158 Functions Page 155 getStatusTargetRange This function gets information about whether the selected axis’ positioner is in target range or not. The detection only indicates whether the position is within the defined range. This status is updated periodically but currently not in real-time.
  • Page 159 Page 156 Table of Contents About 3.12 getInstalledPackages Get list of packages installed on the device Function specific parameters errNo errorCode value_string1 string: Comma separated list 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 size0) Python value_string1 = [dev].about.getInstalledPackages()
  • Page 160 Functions Page 157 getPackageLicense Get the license for a specific package Function specific parameters pckg string: Package name errNo errorCode value_string1 string: License for this package JSON 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 size0) Python value_string1 = [dev].about.getPackageLicense(pckg)

  • Page 161: About 156 3.13 System_Service

    Page 158 Table of Contents System_service 3.13 apply Apply temporary system configuration Function specific parameters errNo errorCode JSON Method method: com.attocube.system.apply params: [] Result: [errNo] C-DLL call int system_apply(int deviceHandle) Python [dev].system_service.apply() Matlab [] = system_apply() void value = [Device].Apply() LabVIEW apply.vi...
  • Page 162 Functions Page 159 errorNumberToRecommendation Get a recommendation for the error code Function specific parameters language integer: Language code errNbr interger: Error code to translate errNo errorCode string: Error recommendation (currently returning an value_string1 int = 0 until we have recommendations) JSON Method method: com.attocube.system.errorNumberToRecommendation params: [language, errNbr]...
  • Page 163 Page 160 Table of Contents errorNumberToString Get a description of an error code Function specific parameters integer: Language code 0 for the error name, 1 for a language more user friendly error message errNbr interger: Error code to translate errNo errorCode value_string1 string: Error description...
  • Page 164 Functions Page 161 factoryReset Turns on the factory reset flag. To perform the factory reset, a reboot is necessary afterwards. All settings will be set to default and the IDS will be configured as DHCP server. Function specific parameters errNo errorCode JSON Method method: com.attocube.system.factoryReset...
  • Page 165 Page 162 Table of Contents getDeviceName Get the actual device name Function specific parameters errNo errorCode value_string1 string: actual 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_string1 = [dev].system_service.getDeviceName() Matlab [value_string1] = system_getDeviceName()
  • Page 166 Functions Page 163 getFirmwareVersion Get the firmware version of the system Function specific parameters errNo errorCode value_string1 string: The firmware version 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_string1 = [dev].system_service.getFirmwareVersion() Matlab [value_string1] = system_getFirmwareVersion()
  • Page 167 Page 164 Table of Contents getFluxCode Get the flux code of the system Function specific parameters errNo errorCode value_string1 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_string1 = [dev].system_service.getFluxCode() Matlab...
  • Page 168 Functions Page 165 getHostname Return device hostname Function specific parameters errNo errorCode available 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_service.getHostname() Matlab [available] = system_getHostname() string value = [Device].GetHostname() LabVIEW getHostname.vi...
  • Page 169 Page 166 Table of Contents getMacAddress Get the mac address of the system Function specific parameters errNo errorCode value_string1 string: Mac 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 value_string1 = [dev].system_service.getMacAddress() Matlab...
  • Page 170 Functions Page 167 getSerialNumber Get the serial number of the system Function specific parameters errNo errorCode value_string1 string: Serial 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_string1 = [dev].system_service.getSerialNumber() Matlab [value_string1] = system_getSerialNumber() string value = [Device].GetSerialNumber()

  • Page 171: Network

    Page 168 Table of Contents Network 3.14 apply Apply temporary IP configuration and load it Function specific parameters 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.apply() Matlab [] = system_network_apply() void value = [Device].Network_Apply() LabVIEW apply.vi...
  • Page 172 Functions Page 169 configureWifi Change the wifi configuration and applies it Function specific parameters mode 0: Access point, 1: Wifi client ssid Pre-shared key errNo errorCode JSON 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 [dev].network.configureWifi(mode, ssid, psk)
  • Page 173 Page 170 Table of Contents discard Discard temporary IP configuration Function specific parameters 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() Matlab [] = system_network_discard() void value = [Device].Network_Discard() LabVIEW discard.vi...
  • Page 174 Functions Page 171 getDefaultGateway Get the default gateway of the device Function specific parameters errNo errorCode Default gateway JSON 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].network.getDefaultGateway() Matlab [Default] = system_network_getDefaultGateway() string value = [Device].Network_GetDefaultGateway()
  • Page 175 Page 172 Table of Contents getDnsResolver Get the DNS resolver Function specific parameters priority of DNS resolver (Usually: 0 = Default, 1 = Backup) errNo errorCode address of 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) Python...
  • Page 176 Functions Page 173 getEnableDhcpClient Get the state of DHCP client Function specific parameters errNo errorCode boolean: true = DHCP client enable, false = DHCP value_boolean1 client disable 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) Python value_boolean1 = [dev].network.getEnableDhcpClient()
  • Page 177 Page 174 Table of Contents getEnableDhcpServer Get the state of DHCP server Function specific parameters errNo errorCode boolean: true = DHCP server enable, false = DHCP value_boolean1 server 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) Python...
  • Page 178 Functions Page 175 getIpAddress Get the IP address of the device Function specific parameters errNo errorCode address 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.getIpAddress() Matlab [IP] = system_network_getIpAddress() string value = [Device].Network_GetIpAddress()
  • Page 179 Page 176 Table of Contents getProxyServer Get the proxy settings of the devide Function specific parameters errNo errorCode Proxy Server String, 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 Proxy = [dev].network.getProxyServer() Matlab...
  • Page 180 Functions Page 177 getRealIpAddress Get the real IP address of the device set to the network interface (br0, eth1 or eth0) Function specific parameters errNo errorCode 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 size0) Python IP = [dev].network.getRealIpAddress()
  • Page 181 Page 178 Table of Contents getSubnetMask Get the subnet mask of the device Function specific parameters errNo errorCode Subnet mask 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].network.getSubnetMask() Matlab...
  • Page 182 Functions Page 179 getWifiMode Get the operation mode of the wifi adapter Function specific parameters errNo errorCode 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 = [dev].network.getWifiMode() Matlab...
  • Page 183 Page 180 Table of Contents getWifiPassphrase Get the the passphrase of the network hosted (mode: Access point) or connected to (mode: client) Function specific parameters errNo errorCode 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, int size0) Python...
  • Page 184 Functions Page 181 getWifiPresent Returns is a Wifi interface is present Function specific parameters errNo errorCode True True, 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].network.getWifiPresent() Matlab [True] = system_network_getWifiPresent() bool value = [Device].Network_GetWifiPresent()
  • Page 185 Page 182 Table of Contents getWifiSSID Get the the SSID of the network hosted (mode: Access point) or connected to (mode: client) Function specific parameters 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 size0) Python SSID = [dev].network.getWifiSSID()
  • Page 186 Functions Page 183 setDefaultGateway Set the default gateway of the device Function specific parameters gateway Default gateway as string errNo errorCode 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.setDefaultGateway(gateway) Matlab [] = system_network_setDefaultGateway(gateway) void value = [Device].Network_SetDefaultGateway(string gateway) LabVIEW...
  • Page 187 Page 184 Table of Contents setDnsResolver Set the DNS resolver Function specific parameters priority of DNS resolver (Usually: 0 = Default, 1 = Backup) resolver The resolver's IP address as string errNo errorCode 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...
  • Page 188 Functions Page 185 setEnableDhcpClient Enable or disable DHCP client Function specific parameters boolean: true = enable DHCP client, false = disable enable DHCP client errNo 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].network.setEnableDhcpClient(enable) Matlab...
  • Page 189 Page 186 Table of Contents setEnableDhcpServer Enable or disable DHCP server Function specific parameters boolean: true = enable DHCP server, false = disable enable DHCP server 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 [dev].network.setEnableDhcpServer(enable) Matlab...
  • Page 190 Functions Page 187 setIpAddress Set the IP address of the device Function specific parameters address IP address as string errNo errorCode 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.setIpAddress(address) Matlab [] = system_network_setIpAddress(address) void value = [Device].Network_SetIpAddress(string address) LabVIEW...
  • Page 191 Page 188 Table of Contents setProxyServer Set the proxy server of the device Function specific parameters proxyServer Proxy Server Setting as string errNo errorCode 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].network.setProxyServer(proxyServer) Matlab...
  • Page 192 Functions Page 189 setSubnetMask Set the subnet mask of the device Function specific parameters netmask Subnet mask as string errNo errorCode 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.setSubnetMask(netmask) Matlab [] = system_network_setSubnetMask(netmask) void value = [Device].Network_SetSubnetMask(string netmask) LabVIEW...
  • Page 193 Page 190 Table of Contents setWifiMode Change the operation mode of the wifi adapter Function specific parameters mode 0: Access point, 1: Wifi client 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].network.setWifiMode(mode) Matlab...
  • Page 194 Functions Page 191 setWifiPassphrase Change the passphrase of the network hosted (mode: Access point) or connected to (mode: client) Function specific parameters Pre-shared key 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) Python [dev].network.setWifiPassphrase(psk) Matlab...
  • Page 195 Page 192 Table of Contents setWifiSSID Change the SSID of the network hosted (mode: Access point) or connected to (mode: client) Function specific parameters ssid 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) Python [dev].network.setWifiSSID(ssid) Matlab...
  • Page 196 Functions Page 193 verify Verify that temporary IP configuration is correct Function specific parameters 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() Matlab [] = system_network_verify() void value = [Device].Network_Verify() LabVIEW verify.vi...

  • Page 197: System_Service

    Page 194 Table of Contents System_service 3.15 rebootSystem Reboot the system Function specific parameters errNo errorCode JSON Method method: com.attocube.system.rebootSystem params: [] Result: [errNo] C-DLL call int system_rebootSystem(int deviceHandle) Python [dev].system_service.rebootSystem() Matlab [] = system_rebootSystem() void value = [Device].RebootSystem() LabVIEW rebootSystem.vi...
  • Page 198 Functions Page 195 setDeviceName Set custom name for the device Function specific parameters name string: device name 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.setDeviceName(name) Matlab [] = system_setDeviceName(name) void value = [Device].SetDeviceName(string name) LabVIEW setDeviceName.vi...

  • Page 199: Update

    Page 196 Table of Contents Update 3.16 getLicenseUpdateProgress Get the progress of running license update Function specific parameters errNo errorCode value_int1 int: progress in percent 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 value_int1 = [dev].update.getLicenseUpdateProgress()
  • Page 200 Functions Page 197 getSwUpdateProgress Get the progress of running update Function specific parameters errNo errorCode value_int1 int: progress in percent 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].update.getSwUpdateProgress() Matlab [value_int1] = system_update_getSwUpdateProgress() int value = [Device].Update_GetSwUpdateProgress()
  • Page 201 Page 198 Table of Contents licenseUpdateBase64 Execute the license update with base64 file uploaded. After execution, a manual reboot is nevessary. Function specific parameters errNo errorCode JSON Method method: com.attocube.system.update.licenseUpdateBase64 params: [] Result: [errNo] C-DLL call int system_update_licenseUpdateBase64(int deviceHandle) Python [dev].update.licenseUpdateBase64() Matlab [] = system_update_licenseUpdateBase64()
  • Page 202 Functions Page 199 softwareUpdateBase64 Execute the update with base64 file uploaded. After completion, a manual reboot is necessary. Function specific parameters errNo errorCode JSON Method method: com.attocube.system.update.softwareUpdateBase64 params: [] Result: [errNo] C-DLL call int system_update_softwareUpdateBase64(int deviceHandle) Python [dev].update.softwareUpdateBase64() Matlab [] = system_update_softwareUpdateBase64() void value = [Device].Update_SoftwareUpdateBase64() LabVIEW softwareUpdateBase64.vi...
  • Page 203 Page 200 Table of Contents uploadLicenseBase64 Upload new license file in format base 64 Function specific parameters offset int: offset of the data b64Data string: base64 data errNo errorCode JSON Method 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...
  • Page 204 Functions Page 201 uploadSoftwareImageBase64 Upload new firmware image in format base 64 Function specific parameters offset int: offset of the data b64Data string: base64 data errNo errorCode JSON Method method: com.attocube.system.update.uploadSoftwareImageBase64 params: [offset, b64Data] Result: [errNo] C-DLL call int system_update_uploadSoftwareImageBase64(int deviceHandle, int offset, const char* b64Data) Python [dev].update.uploadSoftwareImageBase64(offset, b64Data)
  • Page 205 Page 202 Table of Contents attocube systems AG Eglfinger Weg 2 85540 Haar, Germany 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 Southwest: Henderson, NV Phone: +1 510 631 1784 Midwest: Delaware, OH...

This manual is also suitable for:

Attocube amc300

Table of Contents