Updated Plugins for Release v4.3.0

Author: Itom Build Server

README.md

@@ -14,7 +14,7 @@ Install the Python Package **requirementsDocuBuild.txt** from [itom](https://git
 Update Plugin-Doc
 -----------------
 
-* Run script: ``../mainsite_hidden/update_plugindoc_source_plugins.py``. Skript will ask you for a folder. Select the ``itom/source`` folder. Script will update exsiting plugin's ``*.rst`` files.
+* Run script: ``../mainsite_hidden/update_plugindoc_source_plugins.py``. Skript will ask you for a folder. Select the ``itomProject/plugins`` folder. Script will update exsiting plugin's ``*.rst`` files.
 * Run Script: ``../mainsite_hidden/create_plugin_documentation.py``. This creates the plugin docu for the website. 
 
 Update Website

plugindoc/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 41290cfdf81e7e2a3fe13134bd6d72e1
+config: 2df66b5e8e5dfa784717e20d00588449
 tags: 645f666f9bcd5a90fca523b33c5a78b7

plugindoc/_sources/plugins/actuators/FirgelliLAC.rst.txt

@@ -10,7 +10,7 @@
 **Devices**:    One axis motor controller FirgelliLAC
 **Author**:     :pluginauthor:`FirgelliLAC`
 =============== ========================================================================================================
- 
+
 Overview
 ========
 
@@ -22,9 +22,9 @@ tested with the product version PQ12-SS-GG-VV-P.
 
 Initialization
 ==============
-  
+
 The following parameters are mandatory or optional for initializing an instance of this plugin:
-    
+
     .. plugininitparams::
         :plugin: FirgelliLAC
 
@@ -38,7 +38,7 @@ parameters can be changed using *setParam*.
 **accuracy**: {float}
     Accuracy in %; range: 0.0..100.0 %
 **async**: {int}
-    asychronous (1) or sychronous (0) mode
+    asynchronous (1) or synchronous (0) mode
 **device_id**: {str}, read-only
     Name of controller
 **device_num**: {int}, read-only
@@ -63,3 +63,5 @@ Changelog
 * 2016-04-07: This plugin will be delivered with itom 2.2.0 for the first time
 * 2016-04-07: The required library MPUSBAPI is delivered with the sources of this plugin in version 1.1.0.
 * itom 4.1.0: This plugin has been compiled
+* itom 4.2.0: This plugin has been compiled
+* itom 4.3.0: This plugin has been compiled

plugindoc/_sources/plugins/actuators/NanotecStepMotor.rst.txt

@@ -10,7 +10,7 @@
 **Devices**:    Motor-Controller Nanotec SMCP
 **Author**:     :pluginauthor:`NanotecStepMotor`
 =============== ========================================================================================================
- 
+
 Overview
 ========
 
@@ -21,9 +21,9 @@ The plugin implements the controllers SMCP from Nanotec.
 
 Initialization
 ==============
-  
+
 The following parameters are mandatory or optional for initializing an instance of this plugin:
-    
+
     .. plugininitparams::
         :plugin: NanotecStepMotor
 
@@ -37,7 +37,7 @@ parameters can be changed using *setParam*.
 **accel**: {seq. of int}
     motor shaft acceleration, range: 1..65.535 [default 2.364]
 **async**: {int}
-    asychronous (1) or sychronous (0) [default] mode
+    asynchronous (1) or synchronous (0) [default] mode
 **axisID**: {seq. of int}
     internal ID of axis
 **axisSteps**: {seq. of float}, read-only
@@ -78,4 +78,10 @@ In the following example, the axes 1 and 4 are connected (controllable by the pl
 They both run at 10 full steps per mm (1) (hence: linear axes):
 
 ser = dataIO("SerialIO",4,115200,"\r",8,1)
-mot = actuator("NanotecStepMotor",ser,[1,4],[10,10],[1,1])
+mot = actuator("NanotecStepMotor",ser,[1,4],[10,10],[1,1])
+
+
+Changelog
+==========
+
+* itom setup 2.1.0: Release

plugindoc/_sources/plugins/actuators/SMC100.rst.txt

@@ -11,7 +11,7 @@
 **Author**:     :pluginauthor:`NewportSMC100`
 **Requires**:   Plugin SerialIO
 =============== ========================================================================================================
- 
+
 Overview
 ========
 
@@ -22,9 +22,9 @@ The plugin implements the Motioncontroller Newport SMC100cc/pp. It can manage up
 
 Initialization
 ==============
-  
+
 The following parameters are mandatory or optional for initializing an instance of this plugin:
-    
+
     .. plugininitparams::
         :plugin: NewportSMC100
 
@@ -42,7 +42,7 @@ parameters can be changed using *setParam*.
 **ctrlId**: {str}, read-only
     device information string
 **current_status**: {intArray}, read-only
-    This intArray stores the status of each controller. While no error occures, the controller should be 
+    This intArray stores the status of each controller. While no error occurs, the controller should be
     notReferenced (LED = orange)
     Referenced (LED = green)
     ConfigMode (LED = red [blinking])
@@ -51,18 +51,18 @@ parameters can be changed using *setParam*.
 **async**: {int} [0,1]
     Defines if the code continues while a controller is processing a task.
 **accel**: {doubleArray}
-    Array of the accelerations of each axis. Notice that if the acceleration is too high, errors can occure because of physical boundaries. These boundaries might be changeable due the serialport. For further information refer to the datasheet.
+    Array of the accelerations of each axis. Notice that if the acceleration is too high, errors can occur because of physical boundaries. These boundaries might be changeable due the serialport. For further information refer to the data sheet.
 **calib_mode**: {intArray} [0,4]
-    Defines the calibration mode, each axis performs when exec_calib is called with an 1 for the corresponding axis. 
+    Defines the calibration mode, each axis performs when exec_calib is called with an 1 for the corresponding axis.
     0 use MZ switch and encoder Index.
     1 use current position as HOME.
     2 use MZ switch only.
     3 use EoR- switch and encoder Index.
     4 use EoR- switch only.
 **config_state**: {intArray} [0,1]
-    Defines wheather an axis switches to config mode. Notice that if an axis is in referenced state a reset is automatically performed to set the axis to notRef state and further into config state. 
+    Defines whether an axis switches to config mode. Notice that if an axis is in referenced state a reset is automatically performed to set the axis to notRef state and further into config state.
 **speed**: {doubleArray}
-    Array of the velocity of each axis. 
+    Array of the velocity of each axis.
 **exec_calib**: {intArray} [0,1]
     By setting this parameter with either a 1 or a 0 for each axis, all axis marked with 1 are calibrated.
 
@@ -79,13 +79,13 @@ Create new Instance:
 
 Switch acceleration, velocity and calib_mode
 
-.. code-block:: python  
+.. code-block:: python
 
     # switch 2 controller to config mode
     plugin.setParam("config_state", [1,1])
-    # plugin.setParam("config_state", [1,0]) => switch ctrl0 to config and if ctrl1 is on config, leave config 
+    # plugin.setParam("config_state", [1,0]) => switch ctrl0 to config and if ctrl1 is on config, leave config
 
-    # set velocity 
+    # set velocity
     plugin.setParam("speed", [5.0,7.0])
 
     # set acceleration
@@ -101,8 +101,8 @@ Switch acceleration, velocity and calib_mode
     plugin.calib(0,1) #calibrate first and second axis
 
     # Controller calibrate and move to referenced state
-    
+
 Known Issues
 ============
 
-In special cases an error occures that leaves the controller in notReferenced state with an error. The LED is constantly red. In this case you have to read the error buffer by sending xTE and xTS where x is the controller number. Notice that the hardware numbers from 1..32 not 0..31 as itom does. Afterwards you can switch into the config mode using xPW1. Choose another calibration mode xHTy, leave the config mode xPW0 and recalibrate the controller with xOR. Further you can send reset commands to the controller (xRS) or unplug the powersupply.
+In special cases an error occurs that leaves the controller in notReferenced state with an error. The LED is constantly red. In this case you have to read the error buffer by sending xTE and xTS where x is the controller number. Notice that the hardware numbers from 1..32 not 0..31 as itom does. Afterwards you can switch into the config mode using xPW1. Choose another calibration mode xHTy, leave the config mode xPW0 and recalibrate the controller with xOR. Further you can send reset commands to the controller (xRS) or unplug the powersupply.

plugindoc/_sources/plugins/actuators/ST8SMC4USB.rst.txt

@@ -10,7 +10,7 @@
 **Devices**:    Motor-Controller STANDA 8SMC4-USB-B8-1
 **Author**:     :pluginauthor:`Standa8SMC4USB`
 =============== ========================================================================================================
- 
+
 Overview
 ========
 
@@ -21,9 +21,9 @@ The plugin implements the controller 8SMC4-USB from STANDA.
 
 Initialization
 ==============
-  
+
 The following parameters are mandatory or optional for initializing an instance of this plugin:
-    
+
     .. plugininitparams::
         :plugin: Standa8SMC4USB
 
@@ -65,12 +65,14 @@ parameters can be changed using *setParam*.
 Installation
 ============
 
-Before using the motor you need to install the communcation driver that is requested once you plug the motor controller to the USB host.
-You get this driver either by installing the software XILab from Standa or by directly downloading the driver's inf file (Windows only). For more information see
-https://en.xisupport.com/projects/enxisupport/wiki/Software. The driver might require the Microsoft Visual C++ 2008 Redistributable package.
+Before using the motor you need to install the communication driver that is requested once you plug the motor controller to the USB host.
+You get this driver either by installing the software XILab from Standa or by directly downloading the driver's inf file (Windows only).
+For more information see https://en.xisupport.com/projects/enxisupport/wiki/Software.
+The driver might require the Microsoft Visual C++ 2008 Redistributable package.
 
 Changelog
 =========
 
 * 2015-06-15: The XiLab SDK currently delivered with the source files of the itom plugin has the version 2.3.2.
-* itom setup 4.1.0: plugin uses the XiLab SDK in version 2.3.2.
+* itom setup 4.1.0: plugin uses the XiLab SDK in version 2.3.2.
+* itom setup 4.3W.0: plugin uses the XiLab SDK in version 2.14.0.

plugindoc/_sources/plugins/actuators/ThorlabsBDCServo.rst.txt

@@ -10,18 +10,21 @@
 **Devices**:    Thorlabs 30 mm XY Stage with Integrated Controller, Brushed DC Servo Motors
 **Author**:     :pluginauthor:`ThorlabsBDCServo`
 =============== ========================================================================================================
- 
+
 Overview
 ========
 
 .. pluginsummaryextended::
     :plugin: ThorlabsBDCServo
 
+ITOM Plugin to be used for interaction with the Thorlabs Benchtop Brushless DC Motor Controllers Series.
+
+
 Initialization
 ==============
-  
+
 The following parameters are mandatory or optional for initializing an instance of this plugin:
-    
+
     .. plugininitparams::
         :plugin: ThorlabsBDCServo
 
@@ -34,15 +37,15 @@ parameters can be changed using *setParam*.
 
 **acceleration**: Sequence[float]
     Acceleration values for each axis in mm/s^2.
-    
+
     *2 values required, Value range: [0, 5], Default: [5, 5]*
 **async**: int
-    asychronous (1) or synchronous (0) mode
-    
+    asynchronous (1) or synchronous (0) mode
+
     *Value range: [0, 1], Default: 0*
 **backlash**: Sequence[float]
     Backlash distance setting in mm (used to control hysteresis).
-    
+
     *2 values required, Value range: [0, 5], Default: [0, 0]*
 **channel**: Sequence[int], read-only
     Channel number of each axis.
@@ -51,44 +54,45 @@ parameters can be changed using *setParam*.
 **enabled**: Sequence[int]
     If 1, the axis is enabled and power is applied to the motor. 0: disabled, the motor can
     be turned by hand.
-    
+
     *Allowed number of values: 0 - 2, Value range: [0, 1], Default: [1, 1]*
 **firmwareVersion**: int, read-only
     Firmware version of the device
 **homed**: Sequence[int], read-only
     If 0, the axis is not homed. 1: homed.
-    
+
     *Allowed number of values: 0 - 2, Value range: [0, 1], Default: [1, 1]*
 **maximumTravelPosition**: Sequence[float], read-only
     Maximum travel position for each axis in mm.
-    
+
     *2 values required, Value range: [15, 15], Default: [15, 15]*
 **minimumTravelPosition**: Sequence[float], read-only
     Minimum travel position for each axis in mm.
-    
+
     *2 values required, Value range: [-15, -15], Default: [-15, -15]*
 **name**: str, read-only
     name of plugin
 **numaxis**: int, read-only
     number of axes (channels)
-    
+
     *Value range: [0, 100], Default: 2*
 **serialNumber**: str, read-only
     Serial number of the device
 **timeout**: float
     Timeout for positioning in seconds.
-    
+
     *Value range: [0, 200], Default: 5*
 **velocity**: Sequence[float]
     Velocity values for each axis in mm/s.
-    
+
     *2 values required, Value range: [0, 2.6], Default: [2.6, 2.6]*
 
 
 Exemplary usage from Python
 =======================================
 
-In the following examples, it is shown how to use this Plugin in itom. The example shows a typical measurement routine. First the homing run is performed, then the stage moves to a start position and from there a certain range is rastered in both axes. 
+In the following examples, it is shown how to use this Plugin in itom. The example shows a typical measurement routine. First the homing run is performed,
+then the stage moves to a start position and from there a certain range is rastered in both axes.
 
 .. code-block:: python
 
@@ -99,6 +103,7 @@ In the following examples, it is shown how to use this Plugin in itom. The examp
     mot = actuator("ThorlabsBDCServo")
 
     # set some parameter
+    mot.setParam("enabled", [1,1])
     mot.setParam("velocity", [2.6, 2.6])
     mot.setParam("acceleration", [5.0,5.0])
     mot.setParam("backlash", [0,0])
@@ -129,7 +134,7 @@ In the following examples, it is shown how to use this Plugin in itom. The examp
 
     # move by using absolute positions
     for absX in xVec:
-        mot.setPosAbs(0, absX)
+        mot.setPosAbs(0, absX, 1, measureStartPos[1])
         for absY in yVec:
             mot.setPosAbs(1, absY)
             print("x: {}, y: {}".format(mot.getPos(0), mot.getPos(1)))
@@ -148,13 +153,22 @@ In the following examples, it is shown how to use this Plugin in itom. The examp
 Compilation
 ===========
 
-To compile this plugin, install the Thorlabs KINESIS driver package in the same bit-version than itom (32/64bit). 
+To compile this plugin, install the Thorlabs KINESIS from
+https://www.thorlabs.com/software_pages/ViewSoftwarePage.cfm?Code=Motion_Control&viewtab=0
+driver package in the same bit-version than itom (32/64bit).
 It has been implemented using KINESIS version 1.14.32.
-Then set the CMake variable **THORLABS_KINESIS_DIRECTORY** to the base directory of Kinesis (e.g. C:/Program Files/Thorlabs/Kinesis).
-The required libraries from Kinesis will automatically be copied to the *lib* folder of itom. Do not use Kinesis 1.6.0 or below for compiling this plugin.
+Then set the CMake variable **THORLABS_KINESIS_DIRECTORY** or the environment variable **THORLABS_KINESIS_ROOT**
+to the base directory of Kinesis (e.g. C:/Program Files/Thorlabs/Kinesis).
+The required libraries from Kinesis will automatically be copied to the *lib* folder of itom.
+Do not use Kinesis 1.6.0 or below for compiling this plugin.
 
 Kinesis 1.7.0 requires the Microsoft C++ Redistributable 2012.
 
 Changelog
 ==========
 
+* itom setup 4.0.0: This plugin has been compiled with Thorlabs Kinesis 1.14.23;
+* itom setup 4.1.0: This plugin has been compiled with Thorlabs Kinesis 1.14.25.
+* itom setup 4.2.0: This plugin has been compiled with Thorlabs Kinesis 1.14.28.
+* Fix bug of timeout during ``setPosAbs``.* itom setup 4.3.0: This plugin has been compiled with Thorlabs Kinesis 1.14.35.
+* itom setup 4.2.0: This plugin has been compiled with Thorlabs Kinesis 1.14.47.