LA1

SPB

[add component documentation]

LAS

[add component documentation]

LCD-2

[add component documentation]

PROC

[add component documentation]

800NM_1

Instance id:SPB_LAS_LCD-2/PROC/800NM_1 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:SPB_NOPA_BEAM_POS, SPB_NOPA_BEAM_POS_ALL, SPB_NOPA_BEAM_POS Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

CAM

[add component documentation]

800NM_1

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

RR

[add component documentation]

SYS

[add component documentation]

ADC

[add component documentation]

UTC1-2

Instance id:SPB_RR_SYS/ADC/UTC1-2 Class id:FastAdc Host:la1-rr-ppl-con-1 Class documentation:  FastAdc Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/fastAdc Last modified:2021-10-05T11:19:39.976+02:00 Created at:2016-12-22T15:17:58.000+01:00 Main authors:Hauf, Mamchykd, Fernands Latest tag:2.8.6-2.11.1 Deployment tag:2.8.6-2.11.1 Scenes:AMPHOS_burst_shape Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Installation not found in a standard path!

Fast ADC

The FastADC device is documented in fastadc:welcome

Trouble Shooting

• If the device instantiate and goes immediately into error, even after server restarts,

check the configuration of the Map directory parameter. For most crates it should be pointing to /home/xctrl/maps. If the problem persists, likely the driver was not loaded. If you have xctrl access to the crate, check if the Device file is present. If it is not or you do not have access, call EEE FPGA OCD.

• If you see flat noise in the raw data, stop the acquisition, click the ADC Reset button and start acquisition. If this doesn’t help, try restarting the device server (right click in the project, or topology view). If further help is needed, contact EEE FPGA OCD (9-8041).
• Make sure you have enablePeakComputation checked for those channels where you need it
• If you are outputting raw data and have incomplete data, or the device crashes recurrently, check the number of samples you are using. Known working sample numbers are ~800k samples on each channel.

Device Schema Description

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• heartbeatInterval:

  The heartbeat interval

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• globalAlarmCondition:

  This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.

• visibility:

  Configures who is allowed to see this device at all

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server

• pid:

  The unix process ID of the device (i.e. of the server)

• state:

  The current state the device is in

• status:

  A more detailed status description

• lockedBy:

  The name of the device holding a lock on this one (empty if not locked)

• slotClearLock:

  Clear the lock on this device

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• log:

  Logging settings

• performanceStatistics:

  Accumulates some statistics

• deviceFile:

  Device driver file to access the hardware (e.g. /dev/pciedevs9).

• mapDirectory:

  Folder where all xml mapping files are located.

• digitizerFrequency:

  ADC sampling frequency.

• adcRange:

  Voltage range (peak to peak) of ADC chips.

• numberRawSamples:

  Number of raw samples to aquire, per channel, with each start of raw data acquisition.

• delay:

  Time delay between trigger and start of raw data acquisition.

• skipSamples:

  If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).

• rawFrequency:

  Raw data sampling frequency.

• timeAxis:

  Time of sample (relative to trigger signal).

• rawDataMode:

  Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.

• rawDynamic:

  When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.

• triggerTime:

  Time between Triggers

• trainId:

  Current train ID as read from the FPGA

• timingSync:

  Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System

• sampleFirstBunch:

  Sample number of the first bunch

• config:

  Board related configuration parameters.

• dacNode:

  Set up DAC parameters

• bunchPatternNode:

  Set up bunch pattern decoding parameters

• channel_0:

  This is a channel of bunch of other parameters

• channel_1:

  This is a channel of bunch of other parameters

• channel_2:

  This is a channel of bunch of other parameters

• channel_3:

  This is a channel of bunch of other parameters

• channel_4:

  This is a channel of bunch of other parameters

• channel_5:

  This is a channel of bunch of other parameters

• channel_6:

  This is a channel of bunch of other parameters

• channel_7:

  This is a channel of bunch of other parameters

• channel_8:

  This is a channel of bunch of other parameters

• channel_9:

  This is a channel of bunch of other parameters

Release History

2.8.6-2.11.1

Created:2021-07-05T18:16:26.000+02:00 Author:Wajid Ehsan Notes:Update tag for utca configuration

2.8.5-2.11.1

Created:2021-07-05T14:39:35.000+02:00 Author:Wajid Ehsan Notes:Add Raw frequency parameter.

2.8.4-2.11.1

Created:2021-07-05T13:49:35.000+02:00 Author:Wajid Ehsan Notes:update iibus tag (Fixed bug with 32 bit signed values_

2.8.3-2.11.1

Created:2021-06-25T13:42:45.000+02:00 Author:Gabriele Giovanetti Notes:FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created:2021-06-15T19:42:44.000+02:00 Author:Wajid Ehsan Notes:Fix bunch period issue

2.8.1-2.11.1

Created:2021-06-15T18:00:03.000+02:00 Author:Wajid Ehsan Notes:Update depends tag

2.8.0-2.11.1

Created:2021-06-11T16:21:15.000+02:00 Author:Bruno Fernandes Notes:FastADC firmware 3.5.21

2.7.8-2.11.1

Created:2021-06-09T11:37:55.000+02:00 Author:Wajid Ehsan Notes:update tag for iibus

2.7.7-2.11.1

Created:2021-06-02T18:15:10.000+02:00 Author:Wajid Ehsan Notes:Fix indentation issues

2.7.6-2.10.0

Created:2021-06-02T09:25:59.000+02:00 Author:Bruno Fernandes Notes:Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created:2021-02-04T14:52:10.000+01:00 Author:Riccardo Fabbri Notes:Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created:2020-11-26T12:52:36.000+01:00 Author:Steffen Hauf Notes:Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created:2020-11-24T14:31:13.000+01:00 Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

2.7.3-2.9.1

Created:2020-09-23T17:43:01.000+02:00 Author:Riccardo Fabbri Notes:Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created:2020-09-11T16:25:10.000+02:00 Author:Wajid Ehsan Notes:Remove deprecated slots

2.7.1-2.9.0

Created:2020-09-10T10:12:17.000+02:00 Author:Robert Schaffer Notes:For Firmware version 3.5

2.7.0-2.9.0

Created:2020-09-09T19:36:37.000+02:00 Author:Robert Schaffer Notes:

2.6.4-2.6.1-only_for_laslab

Created:2019-11-26T13:38:00.000+01:00 Author:Riccardo Fabbri Notes:Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created:2019-11-12T13:27:17.000+01:00 Author:Denys Mamchyk Notes:fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created:2019-07-11T09:56:32.000+02:00 Author:Riccardo Fabbri Notes:BugFix: wipeRawPipelineData: Nr of channels in loop corrected

FXE

[add component documentation]

ILH

[add component documentation]

PPL

[add component documentation]

PROC

[add component documentation]

REF_POS2

Instance id:FXE_ILH_PPL/PROC/REF_POS2 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:FXE_NOPA_BEAM_POS_ALL, FXE_NOPA_BEAM_POS Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

CAM

[add component documentation]

REF_POS2

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

tmp

[add component documentation]

server

Instance id:tmp_server Class id:TimeServer Host:la1-las-sys-utc-1 Class documentation:  TimeServer Alias:sa1-las-ppl-utca-1-cpu , la1-las-sys-utc-1-mch , la1-las-ppl-utca-1-cpu Git repo:https://git.xfel.eu/karaboDevices/timeServer Last modified:2021-09-14T08:39:06.351+02:00 Created at:2016-12-02T14:04:29.000+01:00 Main authors:Hauf, Haufs, Fabbri Latest tag:2.8.1-2.11.1 Deployment tag:2.8.1-2.11.1 Installed tag:2.8.1-2.11.1 Accessible by:CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Time Server Documentation

The Time Server device is documented in timeServer:timeServer

Time Server Troubleshooting

To troubleshooting documentation

TrainId Workflow and Entities

To Train Id workflow documentation

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• tickFactor:

  The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”

• reset:

  Resets the device in case of an error

• id:

  Most recently published actual trigger ID

• periodActual:

  Most recently published actual period of the ID value increment

• idDiff:

  Difference of ID and its previously published value divided by tick factor

• source:

  Select source of trigger ID as an URI (‘local://internal’, ‘local://x2timer’, or ‘tcp://host:port’)

• devfile:

  Local device file to be used if “local://x2timer” was selected

• periodSet:

  Setpoint for the period of the ID value increment (used only for internally generated ID)

• minPeriod:

  Minimum period value to emit a signal.

• maxPeriod:

  Maximum period value to emit a signal.

• badTrainIdsCounter:

  Counter for non increasing trainId events. Maxes out at 100

• badPeriodsCounter:

  Number of times in a tick factor where the period has been set to 0

• badPeriods:

  Last periods out of bounds

• readBunchPatternTable:

  This flag enables the reading of bunch pattern table. To get the full bunch pattern tables with every train use the ‘Full Bunch Pattern Table Updates’ flag.

• bunchPatternTable:

  Is only output if both the ‘readBunchPatternTable’ and ‘fullBunchPatternUpdates’ flags are set.

• fullBunchPatternUpdates:

  If set to true the full bunch pattern table will be updated for each train and logged.

• outputBunchPattern:

  Output channel to which bunch pattern updates are sent. Bunch patterns are only output if the ‘readBunchPatternTable’ is set.

Release History

2.8.1-2.11.1

Created:2021-02-10T16:51:00.000+01:00 Author:Gabriele Giovanetti Notes:‘update-copied-headers’ into ‘master’

2.8.0-2.10.0

Created:2021-02-05T11:41:17.000+01:00 Author:Gero Flucke Notes:Fix bugs on period, C++14, fix CI

2.7.6-2.10.0

Created:2020-11-24T08:08:35.000+01:00 Author:Steffen Hauf Notes:

2.7.5-2.9.1

Created:2020-09-21T14:07:33.000+02:00 Author:Alessandro Silenzi Notes:Skip ticks with bad periods and added a bunch of instrumentation

2.7.4-2.9.1

Created:2020-08-17T11:38:17.000+02:00 Author:Riccardo Fabbri Notes:PatternTable array moved into data node of output channel for DAQ compatibility.

2.7.3-2.9.1

Created:2020-07-22T16:18:32.000+02:00 Author:Riccardo Fabbri Notes:Added slot for toggling data processing.

2.7.2-2.9.1

Created:2020-07-08T22:40:51.000+02:00 Author:Riccardo Fabbri Notes:PplBunchPatternStats: Node maxBufferLength is reconfigurable.

2.7.1-2.9.1

Created:2020-06-26T19:26:19.000+02:00 Author:Riccardo Fabbri Notes:Derive from BunchPattern digest a class with the metrics for PPL bits.

2.7.0-2.9.0

Created:2020-05-27T15:47:21.000+02:00 Author:Steffen Hauf Notes:

2.7.0-2.9

Created:2020-05-27T15:47:21.000+02:00 Author:Steffen Hauf Notes:Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created:2020-02-12T15:34:09.000+01:00 Author:Gero Flucke Notes:Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created:2019-05-07T16:35:38.000+02:00 Author:Alessandro Silenzi Notes:Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created:2019-01-23T10:01:43.000+01:00 Author:Alessandro Silenzi Notes:FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created:2018-12-10T14:26:22.000+01:00 Author:Alessandro Silenzi Notes:added DAQ Policy

2.5.0-2.2.6

Created:2018-11-29T16:54:33.000+01:00 Author:Alessandro Silenzi Notes:Added read Bunch Pattern table feature

2.4.0-2.1.15

Created:2018-02-27T11:18:55.000+01:00 Author:Gero Flucke Notes:Publish signalled trainIds to data logger

2.3.2-2.1.15

Created:2017-09-14T15:41:19.000+02:00 Author:Sergey Esenov Notes:Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created:2017-08-25T10:54:38.000+02:00 Author:Sergey Esenov Notes:Use timing from timing board with the following priority: ‘master’, ‘global’ or ‘board’ to avoid zero values.

2.3.0-2.1.15

Created:2017-08-20T14:55:53.000+02:00 Author:Sergey Esenov Notes:

2.2.0-2.1.12

Created:2017-06-12T15:43:27.000+02:00 Author:esenov Notes:

LA1

[add component documentation]

LAS

[add component documentation]

PPL

[add component documentation]

VALVE

[add component documentation]

VALVE_SPB

Instance id:LA1_LAS_PPL/VALVE/VALVE_SPB Class id:BeckhoffValve Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffValve General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VALVE/VALVE_SPB, Vacuum Monitoring, LA1_LAS_PPL/VACUMM/CONTROL|default, LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VALVE/VALVE_SPB, Vacuum Monitoring, Vacuum-Monitoring, Vacuum Monitoring, LA1_LAS_PPL/VALVE/VALVE_SPB, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• isOpened:

  Status limit switch opened.

• isClosed:

  Status limit switch closed.

• open:

  Instructs device to open

• close:

  Instructs device to close

• invertValue:

  1=invert coil logic

• invertLimits:

  0=Limits active high 1=limits active low

• targetPosition:

  Hardware target position as read from the device

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

VALVE_FXE

Instance id:LA1_LAS_PPL/VALVE/VALVE_FXE Class id:BeckhoffValve Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffValve General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VALVE/VALVE_FXE, Vacuum Monitoring, LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VALVE/VALVE_FXE, Vacuum Monitoring, LA1_LAS_PPL/VALVE/VALVE_FXE, Vacuum-Monitoring, Vacuum Monitoring, LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• isOpened:

  Status limit switch opened.

• isClosed:

  Status limit switch closed.

• open:

  Instructs device to open

• close:

  Instructs device to close

• invertValue:

  1=invert coil logic

• invertLimits:

  0=Limits active high 1=limits active low

• targetPosition:

  Hardware target position as read from the device

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

VALVE_SPARE1

Instance id:LA1_LAS_PPL/VALVE/VALVE_SPARE1 Class id:BeckhoffValve Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffValve General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• isOpened:

  Status limit switch opened.

• isClosed:

  Status limit switch closed.

• open:

  Instructs device to open

• close:

  Instructs device to close

• invertValue:

  1=invert coil logic

• invertLimits:

  0=Limits active high 1=limits active low

• targetPosition:

  Hardware target position as read from the device

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

VALVE_SPARE2

Instance id:LA1_LAS_PPL/VALVE/VALVE_SPARE2 Class id:BeckhoffValve Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffValve General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPARE2 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• isOpened:

  Status limit switch opened.

• isClosed:

  Status limit switch closed.

• open:

  Instructs device to open

• close:

  Instructs device to close

• invertValue:

  1=invert coil logic

• invertLimits:

  0=Limits active high 1=limits active low

• targetPosition:

  Hardware target position as read from the device

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

ACTRL

[add component documentation]

GUIDELASER_SPB_MOD_IN

Instance id:LA1_LAS_PPL/ACTRL/GUIDELASER_SPB_MOD_IN Class id:BeckhoffAnalogOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ACTRL/GUIDELASER_SPB_MOD_IN, LA1_LAS_PPL/ACTRL/GUIDELASER_SPB_MOD_IN, LA1_LAS_PPL/ACTRL/GUIDELASER_SPB_MOD_IN Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The BeckhoffAnalogOutput device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog output of DAC.

• scale:

  Scaling factor for analog value.

• offset:

  Linear offset for analog value.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AO_SIGNAL_BOX_CH1

Instance id:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH1 Class id:BeckhoffAnalogOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH1, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH1, AI_TEST, AI_TEST, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH1, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The BeckhoffAnalogOutput device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog output of DAC.

• scale:

  Scaling factor for analog value.

• offset:

  Linear offset for analog value.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AO_SIGNAL_BOX_CH2

Instance id:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH2 Class id:BeckhoffAnalogOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH2, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH2, AI_TEST, AI_TEST, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH2, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The BeckhoffAnalogOutput device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog output of DAC.

• scale:

  Scaling factor for analog value.

• offset:

  Linear offset for analog value.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AO_SIGNAL_BOX_CH3

Instance id:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH3 Class id:BeckhoffAnalogOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH3, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH3, AI_TEST, AI_TEST, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH3, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The BeckhoffAnalogOutput device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog output of DAC.

• scale:

  Scaling factor for analog value.

• offset:

  Linear offset for analog value.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AO_SIGNAL_BOX_CH4

Instance id:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH4 Class id:BeckhoffAnalogOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH4, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH4, AI_TEST, AI_TEST, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH4, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The BeckhoffAnalogOutput device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog output of DAC.

• scale:

  Scaling factor for analog value.

• offset:

  Linear offset for analog value.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

GUIDELASER_FXE_MOD_IN

Instance id:LA1_LAS_PPL/ACTRL/GUIDELASER_FXE_MOD_IN Class id:BeckhoffAnalogOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ACTRL/GUIDELASER_FXE_MOD_IN, LA1_LAS_PPL/ACTRL/GUIDELASER_FXE_MOD_IN, LA1_LAS_PPL/ACTRL/GUIDELASER_FXE_MOD_IN Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The BeckhoffAnalogOutput device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog output of DAC.

• scale:

  Scaling factor for analog value.

• offset:

  Linear offset for analog value.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

ADC

[add component documentation]

3

Instance id:LA1_LAS_PPL/ADC/3 Class id:FastAdc Host:la1-las-sys-utc-1 Class documentation:  FastAdc Alias:sa1-las-ppl-utca-1-cpu , la1-las-sys-utc-1-mch , la1-las-ppl-utca-1-cpu Git repo:https://git.xfel.eu/karaboDevices/fastAdc Last modified:2021-10-05T11:19:39.976+02:00 Created at:2016-12-22T15:17:58.000+01:00 Main authors:Hauf, Mamchykd, Fernands Latest tag:2.8.6-2.11.1 Deployment tag:2.8.6-2.11.1 Installed tag:2.8.6-2.11.1 Scenes:SPB status scene, SPB 1st stage, SPB 1030 Beam, XF2-Photodiode, PC_EOM_DIAG, adc_test, PC_EOM_DIAG, FXE status scene, FXE 1st stage, FXE 1030 Beam, XF1 Diag Photodiode, SPB Photodiodes, ADC_ch10_kch0, XF2-Photodiode, TMP, AMPHOS_burst_shape Accessible by:CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Fast ADC

The FastADC device is documented in fastadc:welcome

Trouble Shooting

• If the device instantiate and goes immediately into error, even after server restarts,

check the configuration of the Map directory parameter. For most crates it should be pointing to /home/xctrl/maps. If the problem persists, likely the driver was not loaded. If you have xctrl access to the crate, check if the Device file is present. If it is not or you do not have access, call EEE FPGA OCD.

• If you see flat noise in the raw data, stop the acquisition, click the ADC Reset button and start acquisition. If this doesn’t help, try restarting the device server (right click in the project, or topology view). If further help is needed, contact EEE FPGA OCD (9-8041).
• Make sure you have enablePeakComputation checked for those channels where you need it
• If you are outputting raw data and have incomplete data, or the device crashes recurrently, check the number of samples you are using. Known working sample numbers are ~800k samples on each channel.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• start:

  Instructs device to go to started state

• stop:

  Instructs device to go to stopped state

• reset:

  Resets the device in case of an error

• trigger:

  Sends a software trigger to the hardware (always possible, independent of chosen trigger mode)

• deviceFile:

  Device driver file to access the hardware (e.g. /dev/pciedevs9).

• mapDirectory:

  Folder where all xml mapping files are located.

• digitizerFrequency:

  ADC sampling frequency.

• adcRange:

  Voltage range (peak to peak) of ADC chips.

• numberRawSamples:

  Number of raw samples to aquire, per channel, with each start of raw data acquisition.

• delay:

  Time delay between trigger and start of raw data acquisition.

• skipSamples:

  If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).

• rawFrequency:

  Raw data sampling frequency.

• timeAxis:

  Time of sample (relative to trigger signal).

• rawDataMode:

  Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.

• rawDynamic:

  When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.

• triggerTime:

  Time between Triggers

• trainId:

  Current train ID as read from the FPGA

• timingSync:

  Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System

• sampleFirstBunch:

  Sample number of the first bunch

• config:

  Board related configuration parameters.

• dacNode:

  Set up DAC parameters

• bunchPatternNode:

  Set up bunch pattern decoding parameters

• channel_0:

  This is a channel of bunch of other parameters

• channel_1:

  This is a channel of bunch of other parameters

• channel_2:

  This is a channel of bunch of other parameters

• channel_3:

  This is a channel of bunch of other parameters

• channel_4:

  This is a channel of bunch of other parameters

• channel_5:

  This is a channel of bunch of other parameters

• channel_6:

  This is a channel of bunch of other parameters

• channel_7:

  This is a channel of bunch of other parameters

• channel_8:

  This is a channel of bunch of other parameters

• channel_9:

  This is a channel of bunch of other parameters

Release History

2.8.6-2.11.1

Created:2021-07-05T18:16:26.000+02:00 Author:Wajid Ehsan Notes:Update tag for utca configuration

2.8.5-2.11.1

Created:2021-07-05T14:39:35.000+02:00 Author:Wajid Ehsan Notes:Add Raw frequency parameter.

2.8.4-2.11.1

Created:2021-07-05T13:49:35.000+02:00 Author:Wajid Ehsan Notes:update iibus tag (Fixed bug with 32 bit signed values_

2.8.3-2.11.1

Created:2021-06-25T13:42:45.000+02:00 Author:Gabriele Giovanetti Notes:FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created:2021-06-15T19:42:44.000+02:00 Author:Wajid Ehsan Notes:Fix bunch period issue

2.8.1-2.11.1

Created:2021-06-15T18:00:03.000+02:00 Author:Wajid Ehsan Notes:Update depends tag

2.8.0-2.11.1

Created:2021-06-11T16:21:15.000+02:00 Author:Bruno Fernandes Notes:FastADC firmware 3.5.21

2.7.8-2.11.1

Created:2021-06-09T11:37:55.000+02:00 Author:Wajid Ehsan Notes:update tag for iibus

2.7.7-2.11.1

Created:2021-06-02T18:15:10.000+02:00 Author:Wajid Ehsan Notes:Fix indentation issues

2.7.6-2.10.0

Created:2021-06-02T09:25:59.000+02:00 Author:Bruno Fernandes Notes:Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created:2021-02-04T14:52:10.000+01:00 Author:Riccardo Fabbri Notes:Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created:2020-11-26T12:52:36.000+01:00 Author:Steffen Hauf Notes:Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created:2020-11-24T14:31:13.000+01:00 Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

2.7.3-2.9.1

Created:2020-09-23T17:43:01.000+02:00 Author:Riccardo Fabbri Notes:Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created:2020-09-11T16:25:10.000+02:00 Author:Wajid Ehsan Notes:Remove deprecated slots

2.7.1-2.9.0

Created:2020-09-10T10:12:17.000+02:00 Author:Robert Schaffer Notes:For Firmware version 3.5

2.7.0-2.9.0

Created:2020-09-09T19:36:37.000+02:00 Author:Robert Schaffer Notes:

2.6.4-2.6.1-only_for_laslab

Created:2019-11-26T13:38:00.000+01:00 Author:Riccardo Fabbri Notes:Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created:2019-11-12T13:27:17.000+01:00 Author:Denys Mamchyk Notes:fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created:2019-07-11T09:56:32.000+02:00 Author:Riccardo Fabbri Notes:BugFix: wipeRawPipelineData: Nr of channels in loop corrected

2

Instance id:LA1_LAS_PPL/ADC/2 Class id:FastAdc Host:la1-las-sys-utc-1 Class documentation:  FastAdc Alias:sa1-las-ppl-utca-1-cpu , la1-las-sys-utc-1-mch , la1-las-ppl-utca-1-cpu Git repo:https://git.xfel.eu/karaboDevices/fastAdc Last modified:2021-10-05T11:19:39.976+02:00 Created at:2016-12-22T15:17:58.000+01:00 Main authors:Hauf, Mamchykd, Fernands Latest tag:2.8.6-2.11.1 Deployment tag:2.8.6-2.11.1 Installed tag:2.8.6-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:FXE Spectrum and BCC, SPB BCC and spectrum, SPBdmRFSignal, kuyuf, SPB BCC and spectrum, ADC_test_CH9(1)_pcie3, FXE Spectrum and BCC, dmBCCRAWDATA, FXEdmRFSignal, dm-BCC-SPB-Main, ADC_test_CH9(1)_pcie3, SPBdmRFSignal, dmBCCRAWDATA, FXEdmRFSignal, ADC_ch10_kch0 Accessible by:CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Fast ADC

The FastADC device is documented in fastadc:welcome

Trouble Shooting

• If the device instantiate and goes immediately into error, even after server restarts,

check the configuration of the Map directory parameter. For most crates it should be pointing to /home/xctrl/maps. If the problem persists, likely the driver was not loaded. If you have xctrl access to the crate, check if the Device file is present. If it is not or you do not have access, call EEE FPGA OCD.

• If you see flat noise in the raw data, stop the acquisition, click the ADC Reset button and start acquisition. If this doesn’t help, try restarting the device server (right click in the project, or topology view). If further help is needed, contact EEE FPGA OCD (9-8041).
• Make sure you have enablePeakComputation checked for those channels where you need it
• If you are outputting raw data and have incomplete data, or the device crashes recurrently, check the number of samples you are using. Known working sample numbers are ~800k samples on each channel.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• start:

  Instructs device to go to started state

• stop:

  Instructs device to go to stopped state

• reset:

  Resets the device in case of an error

• trigger:

  Sends a software trigger to the hardware (always possible, independent of chosen trigger mode)

• deviceFile:

  Device driver file to access the hardware (e.g. /dev/pciedevs9).

• mapDirectory:

  Folder where all xml mapping files are located.

• digitizerFrequency:

  ADC sampling frequency.

• adcRange:

  Voltage range (peak to peak) of ADC chips.

• numberRawSamples:

  Number of raw samples to aquire, per channel, with each start of raw data acquisition.

• delay:

  Time delay between trigger and start of raw data acquisition.

• skipSamples:

  If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).

• rawFrequency:

  Raw data sampling frequency.

• timeAxis:

  Time of sample (relative to trigger signal).

• rawDataMode:

  Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.

• rawDynamic:

  When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.

• triggerTime:

  Time between Triggers

• trainId:

  Current train ID as read from the FPGA

• timingSync:

  Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System

• sampleFirstBunch:

  Sample number of the first bunch

• config:

  Board related configuration parameters.

• dacNode:

  Set up DAC parameters

• bunchPatternNode:

  Set up bunch pattern decoding parameters

• channel_0:

  This is a channel of bunch of other parameters

• channel_1:

  This is a channel of bunch of other parameters

• channel_2:

  This is a channel of bunch of other parameters

• channel_3:

  This is a channel of bunch of other parameters

• channel_4:

  This is a channel of bunch of other parameters

• channel_5:

  This is a channel of bunch of other parameters

• channel_6:

  This is a channel of bunch of other parameters

• channel_7:

  This is a channel of bunch of other parameters

• channel_8:

  This is a channel of bunch of other parameters

• channel_9:

  This is a channel of bunch of other parameters

Release History

2.8.6-2.11.1

Created:2021-07-05T18:16:26.000+02:00 Author:Wajid Ehsan Notes:Update tag for utca configuration

2.8.5-2.11.1

Created:2021-07-05T14:39:35.000+02:00 Author:Wajid Ehsan Notes:Add Raw frequency parameter.

2.8.4-2.11.1

Created:2021-07-05T13:49:35.000+02:00 Author:Wajid Ehsan Notes:update iibus tag (Fixed bug with 32 bit signed values_

2.8.3-2.11.1

Created:2021-06-25T13:42:45.000+02:00 Author:Gabriele Giovanetti Notes:FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created:2021-06-15T19:42:44.000+02:00 Author:Wajid Ehsan Notes:Fix bunch period issue

2.8.1-2.11.1

Created:2021-06-15T18:00:03.000+02:00 Author:Wajid Ehsan Notes:Update depends tag

2.8.0-2.11.1

Created:2021-06-11T16:21:15.000+02:00 Author:Bruno Fernandes Notes:FastADC firmware 3.5.21

2.7.8-2.11.1

Created:2021-06-09T11:37:55.000+02:00 Author:Wajid Ehsan Notes:update tag for iibus

2.7.7-2.11.1

Created:2021-06-02T18:15:10.000+02:00 Author:Wajid Ehsan Notes:Fix indentation issues

2.7.6-2.10.0

Created:2021-06-02T09:25:59.000+02:00 Author:Bruno Fernandes Notes:Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created:2021-02-04T14:52:10.000+01:00 Author:Riccardo Fabbri Notes:Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created:2020-11-26T12:52:36.000+01:00 Author:Steffen Hauf Notes:Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created:2020-11-24T14:31:13.000+01:00 Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

2.7.3-2.9.1

Created:2020-09-23T17:43:01.000+02:00 Author:Riccardo Fabbri Notes:Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created:2020-09-11T16:25:10.000+02:00 Author:Wajid Ehsan Notes:Remove deprecated slots

2.7.1-2.9.0

Created:2020-09-10T10:12:17.000+02:00 Author:Robert Schaffer Notes:For Firmware version 3.5

2.7.0-2.9.0

Created:2020-09-09T19:36:37.000+02:00 Author:Robert Schaffer Notes:

2.6.4-2.6.1-only_for_laslab

Created:2019-11-26T13:38:00.000+01:00 Author:Riccardo Fabbri Notes:Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created:2019-11-12T13:27:17.000+01:00 Author:Denys Mamchyk Notes:fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created:2019-07-11T09:56:32.000+02:00 Author:Riccardo Fabbri Notes:BugFix: wipeRawPipelineData: Nr of channels in loop corrected

ASENS

[add component documentation]

HUMIDITY

Instance id:LA1_LAS_PPL/ASENS/HUMIDITY Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity Scenes:LA1_LAS_PPL/ASENS/HUMIDITY, Temperature and Humidity, Temperature and Humidity, LA1_LAS_PPL/ASENS/HUMIDITY, Temperature and Humidity, TEM XF2 SPB-FXE, LA1_LAS_PPL/ASENS/HUMIDITY, Temperature and Humidity, TEM XF2 SPB-FXE, Temperature and Humidity Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AI_SIGNAL_BOX_CH1

Instance id:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH1 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:Seeder Diagnostics, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH1, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH1, LA1_LAS_PPL/SEEDERMON, AI_TEST, AI_TEST, Power, LA1_LAS_PPL/SEEDERMON, Power, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH1, LA1_LAS_PPL/SEEDERMON, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AI_SIGNAL_BOX_CH2

Instance id:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH2 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH2, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH2, AI_TEST, AI_TEST, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH2, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AI_SIGNAL_BOX_CH3

Instance id:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH3 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH3, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH3, AI_TEST, AI_TEST, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH3, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

AI_SIGNAL_BOX_CH4

Instance id:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH4 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH4, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH4, AI_TEST, AI_TEST, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH4, AI_TEST, ADC_DAC Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

EMETER_AMPHOS_DIAG

EMETER_NOPA_FXE_OUT

EMETER_NOPA_SPB_OUT

EMETER_UNCOMP_FXE_OUT

EMETER_UNCOMP_SPB_OUT

GUIDELASER_FXE_CTL_OUT

Instance id:LA1_LAS_PPL/ASENS/GUIDELASER_FXE_CTL_OUT Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ASENS/GUIDELASER_FXE_CTL_OUT, LA1_LAS_PPL/ASENS/GUIDELASER_FXE_CTL_OUT, LA1_LAS_PPL/ASENS/GUIDELASER_FXE_CTL_OUT Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

GUIDELASER_SPB_CTL_OUT

Instance id:LA1_LAS_PPL/ASENS/GUIDELASER_SPB_CTL_OUT Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/ASENS/GUIDELASER_SPB_CTL_OUT, LA1_LAS_PPL/ASENS/GUIDELASER_SPB_CTL_OUT, LA1_LAS_PPL/ASENS/GUIDELASER_SPB_CTL_OUT Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

EMETER_NOPA_FXE_3

EMETER_NOPA_SPB_3

EMETER_FXE_1030

EMETER_SPB_1030

EMETER_GENTEC_TEST1

GENTEC_EMETER_AMPHOS

CAM

[add component documentation]

XF1FE_DIAG

AC_FXE_DIAG

AC_SPB_DIAG

AC_XF2_DIAG

AMPHOS_BOOSTER

AMPHOS_DIAG_FF

AMPHOS_DIAG_NF

AMPHOS_INC_NF

FE_XF1_NF

FE_XF2_NF

FF_CAM_TEM

FXE_Instr_1

FXE_Instr_2

FXE_Instr_3

FXE_UNCOMP

GALVO_FXE

GALVO_SPB

NOPA_FXE_1

NOPA_FXE_2

NOPA_FXE_3

NOPA_FXE_SEED

NOPA_SPB_1

NOPA_SPB_2

NOPA_SPB_SEED

SPB_Instr_1

SPB_Instr_2

SPB_Instr_3

SPB_UNCOMP

XF1DIAG_SPB_TEM

NOPA_SPB_3

AC_SPB_DIAG_LIMA

Instance id:LA1_LAS_PPL/CAM/AC_SPB_DIAG_LIMA Host:exflcon205 Class documentation:  LimaBaslerCamera Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

FXE_Spare

Instance id:LA1_LAS_PPL/CAM/FXE_Spare Host:exflcon205 Class documentation:  LimaBaslerCamera Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-02-19T15:00:57.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.2-2.7.1 Deployment tag:5.5.11-2.6.2 Installed tag:5.5.11-2.6.2 Projects:LA1_LAS_PPL_20180720_BAK Scenes:Near Field XF1 Accessible by:CONTROLS, DA, WP78, brambrin, pallasf

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.2-2.7.1

Created:2020-02-19T14:29:17.000Z Author:Andrea Parenti Notes:Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

GALVO_SPB_LIMA

Instance id:LA1_LAS_PPL/CAM/GALVO_SPB_LIMA Host:exflcon205 Class documentation:  LimaBaslerCamera Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

NOPA_SPB_1_LIMA

Instance id:LA1_LAS_PPL/CAM/NOPA_SPB_1_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-gui2 , la1-rr-sys-con-gui2 , la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

NOPA_SPB_2_LIMA

Instance id:LA1_LAS_PPL/CAM/NOPA_SPB_2_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-gui2 , la1-rr-sys-con-gui2 , la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

NOPA_SPB_3_LIMA

Instance id:LA1_LAS_PPL/CAM/NOPA_SPB_3_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-rr-ppl-con-2 , la1-rr-sys-con-gui2 , la1-gui2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-02-19T15:00:57.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.2-2.7.1 Deployment tag:5.5.11-2.6.2 Installed tag:5.5.11-2.6.2 Accessible by:CONTROLS, DA, WP78, brambrin, pallasf

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.2-2.7.1

Created:2020-02-19T14:29:17.000Z Author:Andrea Parenti Notes:Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

NOPA_SPB_SEED_LIMA

Instance id:LA1_LAS_PPL/CAM/NOPA_SPB_SEED_LIMA Host:exflcon205 Class documentation:  LimaBaslerCamera Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

SPB_Instr_1_LIMA

Instance id:LA1_LAS_PPL/CAM/SPB_Instr_1_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-gui2 , la1-rr-sys-con-gui2 , la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

SPB_Instr_2_LIMA

Instance id:LA1_LAS_PPL/CAM/SPB_Instr_2_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-gui2 , la1-rr-sys-con-gui2 , la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

SPB_Instr_3_LIMA

Instance id:LA1_LAS_PPL/CAM/SPB_Instr_3_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-gui2 , la1-rr-sys-con-gui2 , la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

SPB_UNCOMP_LIMA

Instance id:LA1_LAS_PPL/CAM/SPB_UNCOMP_LIMA Host:exflcon70n0 Class documentation:  LimaBaslerCamera Alias:la1-gui2 , la1-rr-sys-con-gui2 , la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

XF1DIAG_SPB_TEM_LIMA

Instance id:LA1_LAS_PPL/CAM/XF1DIAG_SPB_TEM_LIMA Host:exflcon205 Class documentation:  LimaBaslerCamera Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/limaCameras Last modified:2020-01-10T10:07:56.000+01:00 Created at:2017-01-06T16:32:44.000+01:00 Main authors:Parenti, Kirienko, Giovanetti Latest tag:5.6.1-2.7.0 Deployment tag:5.5.11-2.6.2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

[add instance documentation]

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Release History

5.6.1-2.7.0

Created:2020-01-10T09:34:31.000Z Author:Andrea Parenti Notes:Just refactoring - no functional change.

5.6.0-2.7.0

Created:

2020-01-08T08:03:11.000Z

Author:

Andrea Parenti

Notes:

• New basler scene.
• Make use of imageSourcePy.

5.5.11-2.6.2

Created:2019-11-25T10:18:38.000Z Author:Christopher Youngman Notes:

5.5.10-2.6.2

Created:2019-10-22T12:34:02.000Z Author:Andrea Parenti Notes:FIX frame rate calculation

5.5.9-2.6.2

Created:

2019-10-16T13:56:44.000Z

Author:

Andrea Parenti

Notes:

• Use appendSchema instead of updateSchema
• Update docs and add troubleshooting

5.5.8-2.6.0

Created:2019-09-02T15:37:15.000Z Author:Gabriele Giovanetti Notes:

5.5.7-2.6.0

Created:2019-08-22T10:25:58.000Z Author:Gabriele Giovanetti Notes:Load configuration upon connection

5.5.6-2.6.0

Created:2019-08-13T10:22:06.000Z Author:Andrea Parenti Notes:Add support to Ubuntu 18.04

5.5.5hotfix-2.5.0

Created:2019-07-17T08:42:52.000Z Author:Andrea Parenti Notes:Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1

5.5.5-2.5.0

Created:2019-06-17T10:54:46.000Z Author:Andrea Parenti Notes:FIX options for read-only parameters

5.5.4-2.4.2

Created:2019-06-05T14:50:41.000Z Author:Andrea Parenti Notes:Add frameRateOut parameter

5.5.3-2.3.5

Created:2019-03-06T13:25:32.000Z Author:Andrea Parenti Notes:Do not block the newImage callback

5.5.2-2.3.0

Created:2018-11-13T13:58:33.000Z Author:Andrea Parenti Notes:Same as 5.5.1-2.2.6, but for Python 3.6

5.5.1-2.2.6

Created:2018-10-25T12:04:01.000Z Author:Andrea Parenti Notes:Fix DAQ output schema for rotated images

5.5.0-2.2.6

Created:

2018-10-25T09:22:39.000Z

Author:

Andrea Parenti

Notes:

• Remove file saving feature
• Minor changes to the default scene

5.4.3-2.2.4

Created:2018-09-26T13:13:49.000Z Author:Dennis Goeries Notes:

5.4.2-2.2.4

Created:2018-06-11T10:11:46.000Z Author:Andrea Parenti Notes:Fix image rotation

5.4.1-2.2.3

Created:2018-04-26T12:15:59.000Z Author:Andrea Parenti Notes:Quick fix for the 8-bit Basler image display issue

5.4.0-2.2.3

Created:

2018-04-20T07:40:11.000Z

Author:

Andrea Parenti

Notes:

• FEAT: Sets binning in output image
• FIX: X/Y swap in ROI offsets
• FIX: X/Y swap in DAQ image dims

5.3.6-2.2.1

Created:2018-04-18T11:47:27.000Z Author:Dennis Goeries Notes:

AMPHOS_FF

AMPHOS_INPUT_NF

AMPHOS_NF

FE_XF1_FF

FXE_1030

SPB_1030

DCTRL

[add component documentation]

TRACEYCOMP_SPB_2

Instance id:LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_2 Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_2, LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_2, LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_2 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CMCOMPSTAGE

Instance id:LA1_LAS_PPL/DCTRL/CMCOMPSTAGE Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/CMCOMPSTAGE, LA1_LAS_PPL/DCTRL/CMCOMPSTAGE, cmStageMotor, LA1_LAS_PPL/DCTRL/CMCOMPSTAGE, cmStageMotor Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

DMCOMPSTAGE

Instance id:LA1_LAS_PPL/DCTRL/DMCOMPSTAGE Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/DMCOMPSTAGE, LA1_LAS_PPL/DCTRL/DMCOMPSTAGE, LA1_LAS_PPL/DCTRL/DMCOMPSTAGE, dmStageMotor, dmStageMotor Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

GUIDELASER_FXE_LD_REM

Instance id:LA1_LAS_PPL/DCTRL/GUIDELASER_FXE_LD_REM Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/GUIDELASER_FXE_LD_REM, LA1_LAS_PPL/DCTRL/GUIDELASER_FXE_LD_REM, LA1_LAS_PPL/DCTRL/GUIDELASER_FXE_LD_REM, FXE Beam Delivery Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

GUIDELASER_SPB_LD_REM

Instance id:LA1_LAS_PPL/DCTRL/GUIDELASER_SPB_LD_REM Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/GUIDELASER_SPB_LD_REM, LA1_LAS_PPL/DCTRL/GUIDELASER_SPB_LD_REM, LA1_LAS_PPL/DCTRL/GUIDELASER_SPB_LD_REM, SPB-Beam-Delivery Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LAB_CHILLER_REMOTE_START

Instance id:LA1_LAS_PPL/DCTRL/LAB_CHILLER_REMOTE_START Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/LAB_CHILLER_REMOTE_START, LA1_LAS_PPL/DCTRL/LAB_CHILLER_REMOTE_START, LA1_LAS_PPL/DCTRL/LAB_CHILLER_REMOTE_START Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

NANOSSPARE1

Instance id:LA1_LAS_PPL/DCTRL/NANOSSPARE1 Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/NANOSSPARE1, LA1_LAS_PPL/DCTRL/NANOSSPARE1, LA1_LAS_PPL/DCTRL/NANOSSPARE1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_FXE_1

Instance id:LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_1 Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_FXE_2

Instance id:LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_2 Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_2, LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_2, LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_2 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_SPB_1

Instance id:LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_1 Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

ENC

[add component documentation]

TRACEYCOMP_SPB_2

Instance id:LA1_LAS_PPL/ENC/TRACEYCOMP_SPB_2 Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CMCOMPSTAGE

Instance id:LA1_LAS_PPL/ENC/CMCOMPSTAGE Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:cmStageMotor, dmStageMotor, cmStageMotor, dmStageMotor Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

DMCOMPSTAGE

Instance id:LA1_LAS_PPL/ENC/DMCOMPSTAGE Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

NANOSSPARE1

Instance id:LA1_LAS_PPL/ENC/NANOSSPARE1 Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_FXE_1

Instance id:LA1_LAS_PPL/ENC/TRACEYCOMP_FXE_1 Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_FXE_2

Instance id:LA1_LAS_PPL/ENC/TRACEYCOMP_FXE_2 Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_SPB_1

Instance id:LA1_LAS_PPL/ENC/TRACEYCOMP_SPB_1 Class id:BeckhoffEncoder Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffEncoder General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• value:

  Encoder read value

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• offset:

  Linear offset for analog value.

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

GAUGE

[add component documentation]

GAUGE_BEAMPIPE_SPB

Instance id:LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_SPB Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_SPB, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, Vacuum Monitoring, LA1_LAS_PPL/VACUMM/CONTROL|default, LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_SPB, Vacuum Monitoring, Vacuum-Monitoring, Vacuum Monitoring, LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_SPB, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

GAUGE_BEAMPIPE_FXE

Instance id:LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_FXE Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_FXE, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_FXE, Vacuum Monitoring, LA1_LAS_PPL/VACUMM/CONTROL|default, LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_FXE, Vacuum Monitoring, Vacuum-Monitoring, Vacuum Monitoring, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MDL

[add component documentation]

PPL_INFOS_SPB

BECKHOFF_MONITOR

Instance id:LA1_LAS_PPL/MDL/BECKHOFF_MONITOR Class id:BeckhoffMonitor Host:la1-rr-ppl-con-1 General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/BeckhoffMonitor Last modified:2021-06-02T11:48:16.000+02:00 Created at:2018-01-15T14:36:16.000+01:00 Main authors:Fabbri, Kirienko, Silenzi Latest tag:1.1.6-2.10.0 Deployment tag:1.1.6-2.10.0 Scenes:LA1_LAS_PPL/MDL/BECKHOFF_MONITOR|Export PLC params Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• heartbeatInterval:

  The heartbeat interval

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• globalAlarmCondition:

  This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.

• visibility:

  Configures who is allowed to see this device at all

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server

• pid:

  The unix process ID of the device (i.e. of the server)

• state:

  The current state the device is in

• status:

  A more detailed status description

• lockedBy:

  The name of the device holding a lock on this one (empty if not locked)

• slotClearLock:

  Clear the lock on this device

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• log:

  Logging settings

• cppServerId:

  The cppServer where the beckhoffCom is running on

• beckhoffId:

  The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.

• blacklist:

  These devices won’t be instantiated etc.

• groups:

  The available component groups

• components:

  The available components

• instantiateWait:

  The deviceId of beckhoffCom to monitor

• availableScenes:

  Provides scenes for monitor

• timeoutConnectToBCom:

  Timeout for succesfully connect to PLC

• timeoutReadDevConfig:

  Timeout for getting the same number of failures when reading the configuration of devices

• setDefaultDevConfig:

  Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

• outputFileRoot:

  Template string for output XML file

• inputFileTemplate:

  File with variables to save in FW

• configDir:

  Folder to store configuration files

• plcInFwTemplate:

  List of PLCs which have a specific configuration to save, as found in the FW Template

• instantiateDevices:

  Instantiate all devices on selected PLC

• instantiateQuick:

  Instantiate all devices on selected PLC quickly

• instantiateGroupDevices:

  Instantiate all selected group devices in selected PLC

• instantiateComponentDevices:

  Instantiate all selected component devices in selectedPLC

• resetDevices:

  Reset all devices in Error state

• getOfflineDevices:

  Check which devices are still offline

• shutdownDevices:

  Shutdown all devices

• shutdownGroupDevices:

  Shutdown all group devices

• shutdownComponentDevices:

  Shutdown all component devices

• getPLCsInFwTemplate:

  Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

• getPLCsInSystem:

  Get list of PLCs active in current topic

• handleMultiConfigToXML:

  The retrieved config of devices in PLCs is written on an XML file

• handleSingleConfigToXML:

  The retrieved config of devices in selected beckhoffId is written in XML file

• reset:

  Resets this Monitor device

Release History

1.1.6-2.10.0

Created:2021-05-20T19:08:59.000+02:00 Author:Sergey Esenov Notes:Adapted to Python 3.8.x. No new features.

1.1.5-2.9.1

Created:2020-11-16T10:27:47.000+01:00 Author:Riccardo Fabbri Notes:Update version info according to documentation https://in.xfel.eu/readthedocs/docs/karabo/en/latest/library/device_version.html

1.1.5-2.10.0

Created:2020-11-16T10:27:47.000+01:00 Author:Riccardo Fabbri Notes:Indicate 2.10 compatibility

1.1.4-2.4.2

Created:2019-05-28T11:54:20.000+02:00 Author:Yury Kirienko Notes:State handling enhanced

1.1.3-2.4.0

Created:2019-05-21T13:20:15.000+02:00 Author:Riccardo Fabbri Notes:

1.1.2-2.4.0

Created:

2019-05-09T18:43:42.000+02:00

Author:

Riccardo Fabbri

Notes:

Bug-fix to slotInstanceGone slot: redmine #32843

Scene to select PLC added (Yury) Reset slot added

1.1.1-2.4.0

Created:2019-04-30T14:17:25.000+02:00 Author:Riccardo Fabbri Notes:Added variables to SD_MC2BECKHOFF

1.1.0-2.4.0

Created:2019-04-30T10:50:21.000+02:00 Author:Riccardo Fabbri Notes:Bug-fix: State error handled: redmine #32841

1.0.9-2.4.0

Created:2019-03-11T16:27:14.000+01:00 Author:Alessandro Silenzi Notes:Compatibility with new beckhoff methods to retrieve schema

1.0.8-2.2.6

Created:2018-11-06T17:39:58.000+01:00 Author:Riccardo Fabbri Notes:PLC config saved in git repo

1.0.7-2.2.4

Created:2018-09-05T12:40:28.000+02:00 Author:Riccardo Fabbri Notes:Optimized Saving of PLC device config

2.0.0a0

Created:2018-06-15T17:56:09.000+02:00 Author:rfabbri Notes:working xml download

1.0.6-2.2.0

Created:2018-02-05T11:06:05.000+01:00 Author:Dennis Goeries Notes:

1.0.5-2.2.0

Created:2018-02-05T11:06:05.000+01:00 Author:Dennis Goeries Notes:

1.0.4-2.2.0

Created:2018-01-17T14:05:28.000+01:00 Author:Dennis Goeries Notes:

1.0.3-2.2.0

Created:2018-01-16T16:01:25.000+01:00 Author:Dennis Goeries Notes:

1.0.2-2.2.0

Created:2018-01-16T14:55:02.000+01:00 Author:Dennis Goeries Notes:

1.0.1-2.2.0

Created:2018-01-15T18:00:15.000+01:00 Author:Dennis Goeries Notes:

1.0.0-2.2.0

Created:2018-01-15T17:46:45.000+01:00 Author:Dennis Goeries Notes:

CAM_WATCHDOG

CHILLER_MONITOR

MULTI_PATTERN

Instance id:LA1_LAS_PPL/MDL/MULTI_PATTERN Class id:PplMultiSubPattern Host:exflcon146 Alias:la1-br-ppl-con-pattern Git repo:https://git.xfel.eu/karaboDevices/PplPattern Last modified:2021-09-27T13:58:56.750+02:00 Created at:2018-08-06T14:02:03.000+02:00 Main authors:Fabbri, Hauf Latest tag:1.6.0-2.11.0 Deployment tag:1.6.0-2.11.0 Installed tag:1.5.6-2.10.0 Scenes:LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|multi_subpattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|multi_subpattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern Accessible by:CAL, CONTROLS, CTRL, DA, danilevc, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Device is installed in development mode!

Warning

Might be hot-fixed, dt=56 days, 14:58:00!

Warning

The installed tag (1.5.6-2.10.0) does not match tags mentioned in the deployment ([‘1.6.0-2.11.0’])!

PPL multi sub pattern

The PplMultiSubPattern device is documented in pplPattern:welcome

Device Schema Description

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• heartbeatInterval:

  The heartbeat interval

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• globalAlarmCondition:

  This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.

• visibility:

  Configures who is allowed to see this device at all

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server

• pid:

  The unix process ID of the device (i.e. of the server)

• state:

  The current state the device is in

• status:

  A more detailed status description

• lockedBy:

  The name of the device holding a lock on this one (empty if not locked)

• slotClearLock:

  Clear the lock on this device

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• log:

  Logging settings

• doocsTimingServer:

  The name of Doocs timing server to contact

• doocsPatternServer:

  The name of Doocs server to contact for user-defined patterns

• pollingTime:

  Interval to wait before polling for an update from Doocs

• userName:

  The user name of the operator running the server/device

• userGroupName:

  The user-group in the system to be used when contacting the Doocs server to change the ppl pattern. In can happen that some users belong to different groups and they should choose one of them. This will provide the list of bits allowed to be modified by that user-group.

• userLaserBit:

  Selection of the ppl “User Laser” bit to use. Some users can be authorized to write on different bits of the “Bunch Pattern Table” in the Doocs server, according to which group they belong to. The smallest bit is chosen by defaulty, but they can select another one among the allowed ones.

• xfelTrainLength:

  The length of the xfel train

• xfelBunchCharge:

  The charge in the xfel bunches

• xfelBunchTiming:

  The bunch timing wrt to start of train.

• baseFrequency:

  Base frequency for the electron bunches.

• frequencyTable:

  Lookup table for values of the allowed pump-laser pulse frequency

• readFromDoocs:

  Read the current pattern configuration set in the Doocs server

• writeToDoocs:

  The patterns set by the user are written to the Doccs server

• writeSequenceToDoocs:

  The pattern sequence set by the user is written to the Doocs server. To apply it click on ‘Apply User Multi-Patterns’

• availableScenes:

  Scenes for the PplPattern

• isMultiPatternAllowed:

  This Boolean should be true in the Doocs server in order to use the user ppl patterns

• patternType:

  One of the eight possible (A to H) patterns configurable by the user. Select it to read its current status in DOOCS and/or to modify it.

• patternUserSequence:

  The pattern sequence (N[A] + M[B] …). Write Config to Doocs to set a new sequence

• patternDoocsSequence:

  The pattern sequence (N[A] + M[B] …). Read Config from Doocs to retrieve current sequence.

• userPplPattern:

  Locally selected pattern to fire PPL

• doocsPplPattern:

  Actual pattern to fire PPL running in Doocs

• pplTrainLength:

  The length of the complete burst (comprising laser pulses and empty bunches), from first to last pulse in a train.

• totBurstDuration:

  Duration of complete burst from first to last pulse in a train.

• subpattern_0:

  subpattern 0

• subpattern_1:

  subpattern 1

• subpattern_2:

  subpattern 2

• subpattern_3:

  subpattern 3

Release History

1.6.0-2.11.0

Created:2021-09-22T10:58:06.000+02:00 Author:Steffen Hauf Notes:

1.5.7-2.11.0

Created:2021-08-31T14:47:43.000+02:00 Author:Riccardo Fabbri Notes:Software reset added

1.5.6-2.10.0

Created:2021-02-09T10:18:53.000+01:00 Author:Riccardo Fabbri Notes:Summary: Add Karabo 2.10 Versioning Info

1.5.5-2.9.1

Created:2020-08-17T14:00:55.000+02:00 Author:Riccardo Fabbri Notes:Aligned with timeserver change (output is now DAQ compatible).

1.5.4-2.9.1

Created:2020-08-17T13:01:20.000+02:00 Author:Riccardo Fabbri Notes:Input Channel implemented.

1.5.3-2.9.1

Created:2020-07-24T18:32:20.000+02:00 Author:Riccardo Fabbri Notes:PplOverview: Bug/Fix when comparing arrays in decode_bunch_pattern.

1.5.2-2.9.1

Created:2020-07-23T16:32:30.000+02:00 Author:Riccardo Fabbri Notes:Implemented interval for pattern refresh.

1.5.1-2.9.1

Created:2020-06-30T13:44:20.000+02:00 Author:Riccardo Fabbri Notes:Merge of similar functions.

1.5.0-2.9.1

Created:2020-06-30T12:10:56.000+02:00 Author:Riccardo Fabbri Notes:Setter_periodic_pattern: with zero pulses we should have the pattern length to default 1 (one empty).

1.4.9-2.9.1

Created:2020-06-29T11:28:47.000+02:00 Author:Riccardo Fabbri Notes:The update of key isOnPplGrid is independent from update of key isPeriodic.

1.4.8-2.9.1

Created:2020-06-11T10:41:52.000+02:00 Author:Riccardo Fabbri Notes:Updated dependencies on doocsapi and euxfel_bunch_pattern.

1.4.7-2.7.1

Created:2020-04-03T16:55:23.000+02:00 Author:Riccardo Fabbri Notes:Branch Feat/Refactoring merged to master

1.4.6-2.7.1

Created:2020-04-03T16:17:18.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Label changed and keys moved

1.4.5-2.7.1

Created:2020-04-03T11:05:29.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Obsolete intermediate steps removed for clarity

1.4.4-2.7.1

Created:2020-04-01T19:26:11.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Fix/remove not needed code in bases

1.4.3-2.7.1

Created:2020-04-01T15:58:54.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: DaqPolicy updated

1.4.2-2.7.1

Created:2020-04-01T11:30:46.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Align Unittest

1.4.1-2.7.1

Created:2020-03-31T15:00:38.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Align the key to set the ppl grid frequency with the actual pulse frequency in subpattern

1.4.0-2.7.1

Created:2020-03-31T12:14:55.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Optimizing code in _setter_periodic_pattern

1.3.9-2.7.1

Created:2020-03-30T10:27:16.000+02:00 Author:Riccardo Fabbri Notes:Refactoring: Remove redundant index column in lookup table

PPL_INFOS_FXE

USER_STARTER

PATTERNS_OVERVIEW

ADC_PEAKPOS_TEST

ADC_PEAKPOS_TEST_FXE

ADC_PEAKPOS_TEST_SPB

ADC_PEAK_TEST

PPL_OVERVIEW

GALVO_OVERVIEW

NOPA_AMP_OVERVIEW_FXE

NOPA_STAGE_1_FXE

NOPA_STAGE_2_FXE

NOPA_STAGE_3_FXE

PATTERN_CTRL

TEM_XF1_OVERVIEW

TEM_XF2_FXE_OVERVIEW

AMPHOS_OVERVIEW

FE_OVERVIEW

NOPA_AMP_OVERVIEW_SPB

NOPA_STAGE_1_SPB

NOPA_STAGE_2_SPB

NOPA_STAGE_3_SPB

TEM_XF2_SPB_OVERVIEW

BURST_SYNCH_OVERVIEW_FXE

MOTOR

[add component documentation]

WP_TEM

Instance id:LA1_LAS_PPL/MOTOR/WP_TEM Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_TEM, TJ_TEST, motors_limits, LA1_LAS_PPL/MOTOR/WP_TEM, motors, TEM XF1, LA1_LAS_PPL/MOTOR/WP_TEM, TJ_TEST, TEM XF1, motors, TJ_TEST, TEM XF1, TEM-XF1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CYLLENS_FXE_FA

Instance id:LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA, LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA, LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA, LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA|simpleMotorScene Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CYLLENS_FXE_SA

Instance id:LA1_LAS_PPL/MOTOR/CYLLENS_FXE_SA Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CYLLENS_SPB_FA

Instance id:LA1_LAS_PPL/MOTOR/CYLLENS_SPB_FA Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/CYLLENS_SPB_SA, LA1_LAS_PPL/MOTOR/CYLLENS_SPB_SA, LA1_LAS_PPL/MOTOR/CYLLENS_SPB_SA Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CYLLENS_SPB_SA

Instance id:LA1_LAS_PPL/MOTOR/CYLLENS_SPB_SA Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LINSTAGE_SPARE_3

Instance id:LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_3 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_3, motors_limits, LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_3, motors, LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_3, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LINSTAGE_SPARE_4

Instance id:LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_4 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_4, motors_limits, LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_4, motors, LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_4, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1H_NOPA_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1H_NOPA_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPB, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPB, motors, LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPB, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1H_UNCOMP_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1H_UNCOMP_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPB, motors_limits, motors, LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPB, motors, LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPB Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1V_NOPA_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1V_NOPA_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPB, motors_limits, motors, LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPB, motors, LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPB Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1V_UNCOMP_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT1V_UNCOMP_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPB, motors_limits, motors, LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPB, LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPB, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2H_NOPA_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2H_NOPA_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPB, motors_limits, motors, LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPB, motors, LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPB Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2H_UNCOMP_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2H_UNCOMP_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SPB, motors_limits, motors, LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SPB, motors, LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SPB Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2V_NOPA_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2V_NOPA_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPB, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPB, LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPB, motors, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2V_UNCOMP_FXE

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_FXE, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_FXE, motors, LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_FXE, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

MIRROUT2V_UNCOMP_SPB

Instance id:LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPB, motors_limits, LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPB, motors, LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPB, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

ROT_SPARE_3

Instance id:LA1_LAS_PPL/MOTOR/ROT_SPARE_3 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:motors_limits, LA1_LAS_PPL/MOTOR/ROT_SPARE_3, LA1_LAS_PPL/MOTOR/ROT_SPARE_3, motors, LA1_LAS_PPL/MOTOR/ROT_SPARE_3, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

ROT_SPARE_4

Instance id:LA1_LAS_PPL/MOTOR/ROT_SPARE_4 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/ROT_SPARE_4, motors_limits, LA1_LAS_PPL/MOTOR/ROT_SPARE_4, motors, LA1_LAS_PPL/MOTOR/ROT_SPARE_4, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

SPECTUNE_NOPA_FXE

Instance id:LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, FXE_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_3, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_2, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_1, motors_limits, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_2, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_3, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_1, LA1_LAS_PPLMOTORSPECTUNE_NOPA_FXE, motors, LA1_LAS_PPLMOTORSPECTUNE_NOPA_FXE, LA1_LAS_PPLMOTORSPECTUNE_NOPA_FXE, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_2, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_3, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE_1, LA1_LAS_PPLMOTORSPECTUNE_NOPA_FXE, motors, LA1_LAS_PPLMOTORSPECTUNE_NOPA_FXE, LA1_LAS_PPLMOTORSPECTUNE_NOPA_FXE, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

SPECTUNE_NOPA_SPB

Instance id:LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, SPB_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_1, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_3, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_2, motors_limits, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_2, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_3, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_1, LA1_LAS_PPLMOTORSPECTUNE_NOPA_SPB, LA1_LAS_PPL/MOTOR_SPECTUNE_NOPA_SPB, motors, LA1_LAS_PPLMOTORSPECTUNE_NOPA_SPB, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_2, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_3, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB_1, LA1_LAS_PPLMOTORSPECTUNE_NOPA_SPB, motors, LA1_LAS_PPL/MOTOR_SPECTUNE_NOPA_SPB, SPB_SPECTUNING Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_DIAG_FXE

Instance id:LA1_LAS_PPL/MOTOR/WP_DIAG_FXE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_FXE_DIAG, FXEdmRFSignal, LA1_LAS_PPLMOTORWP_FXE_DIAG, FXEdmRFSignal Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_DIAG_SPB

Instance id:LA1_LAS_PPL/MOTOR/WP_DIAG_SPB Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:SPBdmRFSignal, LA1_LAS_PPLMOTORWP_SPB_DIAG, SPBdmRFSignal, LA1_LAS_PPLMOTORWP_SPB_DIAG, LA1_LAS_PPLMOTORWP_SPB_DIAG Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_FXE_1

Instance id:LA1_LAS_PPL/MOTOR/WP_FXE_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_FXE_1, motors_limits, LA1_LAS_PPL/MOTOR/WP_FXE_1, motors, LA1_LAS_PPL/MOTOR/WP_FXE_1, motors_status, motors_status_r0, motors, motors_status_r10, motors_status_r10, LA1_LAS_PPL-MOTOR-WP_FXE_1_UNCOMPRESSED, LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE|waveplate_0 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_FXE_2

Instance id:LA1_LAS_PPL/MOTOR/WP_FXE_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_FXE_2, motors_limits, LA1_LAS_PPL/MOTOR/WP_FXE_2, motors, LA1_LAS_PPL/MOTOR/WP_FXE_2, motors, motors_status_r10, motors_status_r10, LA1_LAS_PPL-MOTOR-WP_FXE_2_COMPRESSED Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_FXE_CR_1

Instance id:LA1_LAS_PPL/MOTOR/WP_FXE_CR_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:FXE_NOPA, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_FXE_CR_1, LA1_LAS_PPLMOTORWP_FXE_CR_1, LA1_LAS_PPLMOTORWP_FXE_CR_1, LA1_LAS_PPLMOTORWP_FXE_CR_1, motors_status, motors_status_r0, motors_status_r10, motors_status_r10 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_FXE_CR_2

Instance id:LA1_LAS_PPL/MOTOR/WP_FXE_CR_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:FXE_NOPA, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_FXE_CR_2, LA1_LAS_PPLMOTORWP_FXE_CR_2, LA1_LAS_PPLMOTORWP_FXE_CR_2, LA1_LAS_PPLMOTORWP_FXE_CR_2 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_FXE_CR_3

Instance id:LA1_LAS_PPL/MOTOR/WP_FXE_CR_3 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, FXE_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_FXE_CR_3, LA1_LAS_PPLMOTORWP_FXE_CR_3, LA1_LAS_PPLMOTORWP_FXE_CR_3, LA1_LAS_PPLMOTORWP_FXE_CR_3 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_NOPA_FXE_1

Instance id:LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, FXE_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_1, motors_limits, LA1_LAS_PPL_MOTOR_WP_NOPA_FXE_1, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_1, motors, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_1, motors, LA1_LAS_PPL_MOTOR_WP_NOPA_FXE_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_NOPA_FXE_2

Instance id:LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:FXE_NOPA, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_2, motors_limits, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_2, motors, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_2, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_NOPA_FXE_3

Instance id:LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_3 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_3, motors_limits, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_3, motors, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_3, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_NOPA_SPB_1

Instance id:LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, SPB_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_1, motors_limits, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_1, LA1_LAS_PPL_MOTOR_WP_NOPA_SPB_1, motors, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_1, motors, LA1_LAS_PPL_MOTOR_WP_NOPA_SPB_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_NOPA_SPB_2

Instance id:LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, SPB_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_2, motors_limits, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_2, motors, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_2, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_NOPA_SPB_3

Instance id:LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_3 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_3, motors_limits, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_3, motors, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_3, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_SPB_1

Instance id:LA1_LAS_PPL/MOTOR/WP_SPB_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_SPB_1, motors_limits, LA1_LAS_PPL/MOTOR/WP_SPB_1, motors, LA1_LAS_PPL/MOTOR/WP_SPB_1, motors, LA1_LAS_PPL-MOTOR-WP_SPB_UNCOMPRESSED Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_SPB_2

Instance id:LA1_LAS_PPL/MOTOR/WP_SPB_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/MOTOR/WP_SPB_2, motors_limits, LA1_LAS_PPL/MOTOR/WP_SPB_2, motors, LA1_LAS_PPL/MOTOR/WP_SPB_2, motors, LA1_LAS_PPL-MOTOR-WP_SPB_COMPRESSED Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_SPB_CR_1

Instance id:LA1_LAS_PPL/MOTOR/WP_SPB_CR_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, SPB_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_SPB_CR_1, LA1_LAS_PPLMOTORWP_SPB_CR_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_SPB_CR_2

Instance id:LA1_LAS_PPL/MOTOR/WP_SPB_CR_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:SPB_NOPA, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_SPB_CR_2, LA1_LAS_PPLMOTORWP_SPB_CR_2 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

WP_SPB_CR_3

Instance id:LA1_LAS_PPL/MOTOR/WP_SPB_CR_3 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, SPB_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPLMOTORWP_SPB_CR_3, LA1_LAS_PPLMOTORWP_SPB_CR_3 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

PLC

[add component documentation]

COM_PLCMON

Instance id:LA1_LAS_PPL/PLC/COM_PLCMON Class id:BeckhoffPlcMonitor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffPlcMonitor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• ACpuFrequency:

  Frequency of the CPU.

• ACurrentCpuUsage:

  Current CPU usage.

• ACurrentCpuTemperature:

  Current temperature of the CPU.

• AProgramMemoryAllocated:

  Allocated program memory.

• AProgramMemoryAvailable:

  Available program memory.

• AStorageMemoryAllocated:

  Allocated storage-memory. Available on Windows CE.

• AStorageMemoryAvailable:

  Available storage-memory. Available on Windows CE.

• AMemoryDivision:

  MemoryDivision. Available on Windows CE.

• AProgramMemoryAllocated2:

  Allocated program memory.

• AProgramMemoryAvailable2:

  Available program memory.

• AMacAddess:

  MAC-Address of the PLC (17 char string).

• AIpv4Address:

  Current IPv4 Address of the PLC in dotted notation (15 char string).

• AIpv4SubnetMask:

  IPv4 subnet mask of the PLC in dotted notation (15 char string).

• ADhcpServerIpv4Address:

  IP-Address of the DHCP-Server in dotted notation (15 char string).

• ADhcpServerEnabled:

  True if the DHCP-Server is enabled.

• AMainboardType:

  Type of the main-board.

• ASerialNumber:

  Serial number.

• AProductionDate:

  Production date of the main-board.

• ABootCount:

  Boot count.

• AOperatingTimeInMinutes:

  Operating time of the main-board.

• AMinBoardTemperature:

  Minimum temperature of the main-board.

• AMaxBoardTemperature:

  Maximum temperature of the main-board.

• MinInputVoltage:

  Minimum input voltage of the main-board.

• MaxInputVoltage:

  Maximum input voltage of the main-board.

• MainboardTemperature:

  Current temperature of the main-board.

• APlcProjectVersion:

  PLC Project Version

• AProjectGeneratorVersion:

  Project Generator Version

• ATCPBufferSize:

  TCP/IP buffer size.

• ATrainID:

  Train ID

• ABeamModes:

  Beam Modes

• ATCPOutputDataRate:

  TCP Output Data Rate

• ATCPOutputBufLvlMax:

  TCP Output Buf Lvl Max

• ATCPInputDataRate:

  TCP Input Data Rate

• ATCPInputBufLvlMax:

  TCP Input Buf Lvl Max

• APLCCycleTime:

  PLC Cycle Time

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

PMOTOR

[add component documentation]

TRACEYCOMP_SPB_2

Instance id:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_2, motors_limits, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_2, motors, TreacyComSPB, TreacyComSPB, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_2, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CMCOMPSTAGE

Instance id:LA1_LAS_PPL/PMOTOR/CMCOMPSTAGE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/CMCOMPSTAGE, PP_layout_karaboo, motors_limits, CM-BCC-Main, motors, RF-Signal, cmStageMotor, Overview, PPL_OVERVIEW, LA1_LAS_PPL/PMOTOR/CMCOMPSTAGE, RF-Signal, motors, Overview_new0, PP_layout_karaboo_V5, PP_layout_karaboo_V6, PP_layout_karaboo_V7, PP_layout_karaboo_V8, PP_layout_karabo, PP_layout_karabo, cmStageMotor, PP_layout_karaboo_V3.svg.2018_11_21_10_15_46.0, CM-test, LA1_LAS_PPL/PMOTOR/CMCOMPSTAGE Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

DMCOMPSTAGE

Instance id:LA1_LAS_PPL/PMOTOR/DMCOMPSTAGE Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/DMCOMPSTAGE, PP_layout_karaboo, motors_limits, FXE Spectrum and BCC, SPB BCC and spectrum, SPBdmRFSignal, SPB BCC and spectrum, motors, FXE Spectrum and BCC, FXEdmRFSignal, dmStageMotor, dm-BCC-SPB-Main, Overview, PPL_OVERVIEW, LA1_LAS_PPL/PMOTOR/DMCOMPSTAGE, motors, Overview_new0, PP_layout_karaboo_V5, PP_layout_karaboo_V6, PP_layout_karaboo_V7, PP_layout_karaboo_V8, PP_layout_karabo, PP_layout_karabo, SPBdmRFSignal, FXEdmRFSignal, dmStageMotor, PP_layout_karaboo_V3.svg.2018_11_21_10_15_46.0, LA1_LAS_PPL/PMOTOR/DMCOMPSTAGE Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

NANOSSPARE1

Instance id:LA1_LAS_PPL/PMOTOR/NANOSSPARE1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/NANOSSPARE1, motors_limits, LA1_LAS_PPL/PMOTOR/NANOSSPARE1, motors, LA1_LAS_PPL/PMOTOR/NANOSSPARE1, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_FXE_1

Instance id:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_1, motors_limits, motors, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_1, motors, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_FXE_2

Instance id:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_2 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_2, motors_limits, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_2, motors, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_2, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TRACEYCOMP_SPB_1

Instance id:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_1 Class id:BeckhoffSimpleMotor Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffSimpleMotor General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_1, motors_limits, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_1, motors, TreacyComSPB, TreacyComSPB, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_1, motors Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The BeckhoffSimpleMotor device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, SD_Stepper (aliased to SD_SIMPLEMOTOR), is documented at this location.

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• off:

  Switch motor current Off.

• on:

  Switch motor current On.

• stop:

  Instructs the device to switch on and stopped.

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• offset:

  Offset will be added to encoder position.

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

PROC

[add component documentation]

XF1_DIAG_SPB_TEM

Instance id:LA1_LAS_PPL/PROC/XF1_DIAG_SPB_TEM Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/XF1DIAG_SPB_TEM, LA1_LAS_PPL/CAM/XF1DIAG_SPB_TEM, LA1_LAS_PPL/CAM/XF1DIAG_SPB_TEM Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

AC_FXE_DIAG

Instance id:LA1_LAS_PPL/PROC/AC_FXE_DIAG Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/AC_FXE_DIAG, LA1_LAS_PPL/CAM/AC_FXE_DIAG, LA1_LAS_PPL/CAM/AC_FXE_DIAG Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

AMPHOS_BOOSTER

Instance id:LA1_LAS_PPL/PROC/AMPHOS_BOOSTER Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-20T23:49:36.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Fabbri, Giovanetti Latest tag:1.27.4-2.9.1 Deployment tag:1.27.4-2.9.1 Scenes:Booster Alignment Cam Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

AMPHOS_DIAG_FF_PROC

Instance id:LA1_LAS_PPL/PROC/AMPHOS_DIAG_FF_PROC Host:exflcon205 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-03-17T11:23:32.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Giovanetti Latest tag:1.27.1-2.8.0 Deployment tag:1.27.1-2.8.0 Installed tag:1.27.1-2.8.0 Projects:Amphos, Amphos, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK, Amphos, Amphos Scenes:Amphos Diagnostic cameras , Amphos Diagnostic cameras , LA1_LAS_PPL/CAM/AMPHOS_DIAG_FF, Amphos Diagnostic cameras , Amphos Diagnostic cameras , LA1_LAS_PPL/CAM/AMPHOS_DIAG_FF, LA1_LAS_PPL/CAM/AMPHOS_DIAG_FF, LA1_LAS_PPL/CAM/AMPHOS_DIAG_FF, Amphos output beam sizes, LA1_LAS_PPL/CAM/AMPHOS_DIAG_FF, Amphos output beam sizes, Amphos Main Accessible by:CAL, CONTROLS, DA, WP78, brambrin, pallasf

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Release History

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created:

2019-02-12T09:02:33.000Z

Author:

Andrea Parenti

Notes:

• Only log first 5 errors in TwoPeakFinder
• Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created:2019-02-01T15:13:24.000Z Author:Cyril Danilevski Notes:Add twin peak finder

1.15.0-2.3.2

Created:

2019-01-31T10:18:10.000Z

Author:

Andrea Parenti

Notes:

• ADD interfaces to all devices
• FIX ImageToSpectrum and ImageNormRoi for K2.3
• FIX states for K2.3 - now ON/PROCESSING

AMPHOS_DIAG_NF_PROC

Instance id:LA1_LAS_PPL/PROC/AMPHOS_DIAG_NF_PROC Host:exflcon205 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-03-17T11:23:32.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Giovanetti Latest tag:1.27.1-2.8.0 Deployment tag:1.27.1-2.8.0 Installed tag:1.27.1-2.8.0 Projects:Amphos, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK, Amphos, Amphos, Amphos Scenes:LA1_LAS_PPL/CAM/AMPHOS_DIAG_NF, Amphos Diagnostic cameras , Amphos Diagnostic cameras , Amphos Diagnostic cameras , Amphos Diagnostic cameras , LA1_LAS_PPL/CAM/AMPHOS_DIAG_NF, LA1_LAS_PPL/CAM/AMPHOS_DIAG_NF, Amphos output beam sizes, LA1_LAS_PPL/CAM/AMPHOS_DIAG_NF, Amphos output beam sizes, Amphos Main Accessible by:CAL, CONTROLS, DA, WP78, brambrin, pallasf

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Release History

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created:

2019-02-12T09:02:33.000Z

Author:

Andrea Parenti

Notes:

• Only log first 5 errors in TwoPeakFinder
• Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created:2019-02-01T15:13:24.000Z Author:Cyril Danilevski Notes:Add twin peak finder

1.15.0-2.3.2

Created:

2019-01-31T10:18:10.000Z

Author:

Andrea Parenti

Notes:

• ADD interfaces to all devices
• FIX ImageToSpectrum and ImageNormRoi for K2.3
• FIX states for K2.3 - now ON/PROCESSING

AMPHOS_INC_NF

Instance id:LA1_LAS_PPL/PROC/AMPHOS_INC_NF Host:exflcon205 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-03-17T11:23:32.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Giovanetti Latest tag:1.27.1-2.8.0 Deployment tag:1.27.1-2.8.0 Installed tag:1.27.1-2.8.0 Scenes:Amphos Input NF Accessible by:CAL, CONTROLS, DA, WP78, brambrin, pallasf

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Release History

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created:

2019-02-12T09:02:33.000Z

Author:

Andrea Parenti

Notes:

• Only log first 5 errors in TwoPeakFinder
• Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created:2019-02-01T15:13:24.000Z Author:Cyril Danilevski Notes:Add twin peak finder

1.15.0-2.3.2

Created:

2019-01-31T10:18:10.000Z

Author:

Andrea Parenti

Notes:

• ADD interfaces to all devices
• FIX ImageToSpectrum and ImageNormRoi for K2.3
• FIX states for K2.3 - now ON/PROCESSING

FE_XF1_NF

Instance id:LA1_LAS_PPL/PROC/FE_XF1_NF Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:FE output cams, (Amphos seed cameras_OLD), Amphos Input Cams 1DGauss, XF1out, FE_XF1-Cam-Images, FE_XF1-Pointing, XF1out Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FE_XF2_NF

Instance id:LA1_LAS_PPL/PROC/FE_XF2_NF Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:FE output cams, XF2_out, FE_XF2-NF-Output, XF2_out Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FF_CAM_TEM

Instance id:LA1_LAS_PPL/PROC/FF_CAM_TEM Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:FF_CAM_TEM, FF_CAM_TEM, TEM XF1, FF_CAM_TEM, TEM XF1, TEM XF1, TEM-XF1 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FXE_Instr_1

Instance id:LA1_LAS_PPL/PROC/FXE_Instr_1 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FXE_Instr_2

Instance id:LA1_LAS_PPL/PROC/FXE_Instr_2 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FXE_Spare_Proc

Instance id:LA1_LAS_PPL/PROC/FXE_Spare_Proc Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-07-31T11:50:20.000+02:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Fabbri, Giovanetti Latest tag:1.27.4-2.9.1 Deployment tag:1.27.4-2.9.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:Near Field XF1 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 peak position from 1D fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 peak position from 1D fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 peak position from 2D fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 peak position from 2D fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

FXE_UNCOMP

Instance id:LA1_LAS_PPL/PROC/FXE_UNCOMP Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-07-31T11:50:20.000+02:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Fabbri, Giovanetti Latest tag:1.27.4-2.9.1 Deployment tag:1.27.4-2.9.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:FXE 1030 Uncompressed Beam, FXE 1030 Beam, FXE 1030 Status Scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

GALVO_FXE

Instance id:LA1_LAS_PPL/PROC/GALVO_FXE Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/GALVO_FXE, GALVO_FXE, LA1_LAS_PPL/CAM/GALVO_FXE, XF1 FXE cameras, LA1_LAS_PPL/CAM/GALVO_FXE, GALVO_FXE, XF1 FXE cameras, LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE|overview Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

GALVO_SPB

Instance id:LA1_LAS_PPL/PROC/GALVO_SPB Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK, SPB_NOPA, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/GALVO_SPB, XF1-SPB cams, LA1_LAS_PPL/CAM/GALVO_SPB, TMP, LA1_LAS_PPL/CAM/GALVO_SPB, XF1-SPB cams, LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB|overview Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_FXE_1

Instance id:LA1_LAS_PPL/PROC/NOPA_FXE_1 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:FXE-1st-stage_test, LA1_LAS_PPL/CAM/NOPA_FXE_1, FXE 1st stage, LA1_LAS_PPL/CAM/NOPA_FXE_1, FXE 1st stage, LA1_LAS_PPL/CAM/NOPA_FXE_1, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview, LA1_LAS_PPL/MDL/NOPA_STAGE_1_FXE|overview Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_FXE_2

Instance id:LA1_LAS_PPL/PROC/NOPA_FXE_2 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:FXE status scene, FXE 2nd stage, FXE user panel, FXE status scene, FXE 2nd stage, FXE user panel, FXE 2nd stage, LA1_LAS_PPL/MDL/NOPA_STAGE_2_FXE|overview Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_FXE_3

Instance id:LA1_LAS_PPL/PROC/NOPA_FXE_3 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:FXE 3rd Stage, FXE 3rd Stage Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_FXE_SEED

Instance id:LA1_LAS_PPL/PROC/NOPA_FXE_SEED Host:exflcon70n0 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 , la1-rr-sys-con-gui2 , la1-gui2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-06-29T14:30:35.000+02:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Giovanetti Latest tag:1.27.1-2.8.0 Deployment tag:1.27.1-2.8.0 Scenes:TEM XF2 SPB-FXE incl setpoints0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• _serverId_:

  Do not set this property, it will be set by the device-server

• _deviceId_:

  Do not set this property, it will be set by the device-server

• _connection_:

  The connection to the communication layer of the distributed system

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• version:

  Version of this Karabo device.

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the processor output values.

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• scale:

  Scaling factor for analog value.

• offset:

  Offset will be added to encoder position.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

• rawValue:

  Digital input of DAC. This value is updated only on request!

• start:

  Instructs device to go to started state

• stop:

  Instructs the device to switch on and stopped.

• resetADC:

  Reset ADC’s of FPGA in case of constant line, No signal

• resetDDR2:

  Resets DDR2 in case of constant line, No signal

• deviceFile:

  Device driver file to access the hardware (e.g. /dev/pciedevs9).

• mapDirectory:

  Folder where all xml mapping files are located.

• numberRawSamples:

  Number of raw samples to aquire, per channel, with each start of raw data acquisition.

• delay:

  Delay between calibration images.

• skipSamples:

  If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).

• triggerTime:

  Time between Triggers

• triggerTimeStat:

  Histogram of time between Triggers

• trainId:

  Current train ID as read from the FPGA

• config:

  Board related configuration parameters.

• dacNode:

  Set up DAC parameters

• channel_0:

  This is a channel of bunch of other parameters

• channel_1:

  This is a channel of bunch of other parameters

• channel_2:

  This is a channel of bunch of other parameters

• channel_3:

  This is a channel of bunch of other parameters

• channel_4:

  This is a channel of bunch of other parameters

• channel_5:

  This is a channel of bunch of other parameters

• channel_6:

  This is a channel of bunch of other parameters

• channel_7:

  This is a channel of bunch of other parameters

• channel_8:

  This is a channel of bunch of other parameters

• channel_9:

  This is a channel of bunch of other parameters

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• Logger:

  Logging settings

• sendCommand:

  Send command to the instrument.

• replyToCommand:

  Reply to the command send to the instrument.

• gotoErrorOnPollFailure:

  Instrument will go to error if poll fails for all properties.

• autoConnect:

  Set True to automatically connect to device.

• pollingInterval:

  The interval for polling the instrument.

• enableHeartbeat:

  Enable Heartbeat

• heartbeatCommand:

  Text to send as heartbeat

• heartbeatReply:

  Heartbeat reply text

• heartbeatPeriod:

  Heartbeat period

• heartbeatTime:

  Last heartbeat time

• pollingTimeTaken:

  Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

• pollNow:

  Poll instrument now!

• _connect_:

  Connects to the device

• disconnect:

  Disconnects from the device

• handshake:

  Set the state of the message roundtrip handshaking.

• baudRate:

  Set the transmit and receive baud rates on the RS-232 port.

• errorCount:

  The number of error records in the queue.

• measureType:

  Set the meter measurement mode (energy or power).

• statisticsMode:

  Set the statistics processing mode (on or off).

• variableDecimation:

  Set the pulse decimation rate (1-99999).

• apertureDiameter:

  Set the aperture diameter.

• wavelength:

  Set the current wavelength.

• gainCompensation:

  Enables or disables the gain compensation.

• gainFactor:

  Set the gain compensation factor.

• range:

  Set the measurement range (maximum expected measurement).

• batchSize:

  Set the statistics batch size.

• restartMode:

  Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

• statStart:

  Terminates the current statistical batch and start a new one.

• statStop:

  Terminates the current statistical batch.

• triggerSource:

  Selects the trigger source (INTernal / EXTernal).

• triggerLevel:

  Set the trigger level (no effect when external trigger is selected).

• triggerSlope:

  Selects the external trigger edge (POSitive / NEGative).

• sequenceId:

  Set the sequence ID.

• triggerBus:

  Selects the trigger bus participation mode.

• itemSelect:

  Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

• statItemSelect:

  Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

• serialNumber:

  The serial number string.

• partNumber:

  The part number.

• modelName:

  The Model Name.

• calibrationDate:

  The calibration date.

• manifacturingDate:

  The manifacturing date.

• defaultWavelength:

  The default wavelength.

• measurementRefreshRate:

  The refresh rate of measurements.

• measurement:

  Last measurement.

• idType:

  The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

• cameraId:

  The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

• packetDelay:

  Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

• autoPacketSize:

  Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

• packetSize:

  Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

• exposureTime:

  This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

• triggerMode:

  This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

• triggerActivation:

  This enumeration sets the signal transition needed to activate the selected trigger.

• autoGain:

  Configures automatic gain feature.

• gain:

  Sets the gain of the ADC converter.

• acquisitionMode:

  This property sets the image acquisition mode.

• frameCount:

  This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

• xPeak1:

  x-position of peak in first calibration image.

• xFWHM1:

  x-FWHM in first calibration image.

• xPeak2:

  x-position of peak in second calibration image.

• xFWHM2:

  x-FWHM in second calibration image.

• delayUnit:

  Unit of the delay between calibration images.

• useAsCalibrationImage1:

  Use the current image as 1st calibration image.

• useAsCalibrationImage2:

  Use the current image as 2nd calibration image.

• calibrate:

  Calibrate actual position to calibrated position.

• calibrationFactor:

  The calibration constant.

• beamShape:

  Time shape of the beam.

• xMinFit:

  Lower limit for the fit.

• xMaxFit:

  Upper limit for the fit.

• fitStatus:

  Error of fit procedure: 1-3 means good fit. See device documentation for further details.

• subtractPedestal:

  Subtract the pedestal, calculated from linear interpolation between first and last point.

• xPeak3:

  x-position of peak in the input image.

• xFWHM3:

  x-FWHM in the input image.

• pulseWidth:

  Duration of the pulse.

• ePulseWidth:

  Uncertainty of the pulse duration arising from fit procedure.

• switchToReady:

  Instructs the amplifier to go to ready state.

• switchOn:

  Instructs the amplifier to go to on state.

• switchOff:

  Instructs the amplifier to go to off state.

• closeShutter2:

  Instructs the amplifier to close Shutter 2.

• openShutter2:

  Instructs the amplifier to open Shutter 2.

• amphosIp:

  The IP address of the Amphos Control.

• amphosPort:

  The port of the Amphos Control.

• stateChanging:

  Laser is currently changing state.

• targetPower:

  Target laser power.

• chillerTemperature:

  Measured temperature of chiller.

• chillerFlow:

  Measured flow of chiller [l/min].

• chillerValvePosition:

  Measured valve position.

• shutter2IsOpen:

  Shutter2 State: False=closed True=open

• lambdaIsBusy:

  Lambda plate is moving.

• laserCurrent:

  Measured current of Amphos400.

• laserTemperature:

  Measured temperature of Amphos400.

• laserHumidity:

  Measured humidity of Amphos400.

• xfelCurrentCW1:

  Measured current of XFEL booster 1 (CW1).

• xfelCurrentCW2:

  Measured current of XFEL booster 1 (CW2).

• xfelCurrentQCW1:

  Measured current of XFEL booster 1 (QCW1).

• xfelCurrentQCW2:

  Measured current of XFEL booster 1 (QCW2).

• xfelCurrentQCW3:

  Measured current of XFEL booster 1 (QCW3).

• xfelCurrentQCW4:

  Measured current of XFEL booster 1 (QCW3).

• xfelTemperature:

  Measured temperature of XFEL booster 1.

• xfelHumidity:

  Measured humidity of XFEL booster 1.

• globalAlarmCondition:

  This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.

• lockedBy:

  The name of the device holding a lock on this one (empty if not locked)

• slotClearLock:

  Clear the lock on this device

• log:

  Logging settings

• adc:

  fast ADC input device

• selectedAdcChannel:

  fast ADC channel in use for the loop

• maxPeakValue:

  Max absolute value for ADC peak. When peak is above this value step is applied

• tuneStage:

  motor controlling the stage to adjust laser path

• stageStep:

  value of stage tuning step size

• loopPeriod:

  Time interval for feedback cycle

• doublecheckWaitTime:

  after peak is above max, this time is waiting to check itagain, before applying step

• calibStepSize:

  Size of calibration step

• calibStepNum:

  Number of calibration steps

• calibAverageNum:

  number of peak values to be averaged for each calibration step

• reverseDirection:

  Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

• conversionFactor:

  micrometers to femtoseconds conversion factor

• adcValueTimeout:

  if ADC value is not updated within this time, device goesin error state

• amphosAmpli:

  Karabo ID of Amphos Laser Amplifier

• triggerDelayDevice:

  Karabo ID of pplDelayControl device, used to read Pockels cell status

• moveToPlus:

  Move to +x position

• moveToMinus:

  Move to -x position

• moveToZero:

  Move to 0 position

• pathToProgramFiles:

  The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

• correctionFile:

  The correction (.ct5) file, including path.

• useExternalTrigger:

  Use external trigger (if true) or auto-run (if false).

• startFromMinusX:

  Set loop initial position to -X

• jumpSpeed:

  The up/down jump speed [bits/ms].

• jumpAmplitude:

  The up/down jump amplitude [bits].

• delayTimePlus:

  Delay time, after moving to position +x.

• delayTimeMinus:

  Delay time, after moving to position -x.

• onTargetTolerance:

  The tolerance [bits] when checking that Galvo is on target position.

• onTargetPlus:

  Galvo is currently at +x position _and_ not moving.

• onTargetMinus:

  Galvo is currently at -x position _and_ not moving.

• laserOn:

  The value of the LASERON signal.

• digitalOut1:

  The value of the DIGITAL OUT1 signal.

• stopEventCode:

  Stop event code.

• galvoTemperature:

  Galvanometer scanner temperature.

• servoTemperature:

  Servo board temperature.

• agcVoltage:

  AGC voltage (PD supply voltage).

• dspCoreVoltage:

  DSP core supply voltage (1.8 V).

• dspIoVoltage:

  DSP IO voltage (3.3 V).

• analogSectVoltage:

  Analog section voltage (9 V).

• adConverterVoltage:

  AD converter supply voltage (5 V).

• galvoHeatingOut:

  Relative heating output of the corresponding galvanometer scanner heater.

• beamline:

  Beamline where to operate

• timingDevice:

  Device ID of PPL Delay Control Device

• galvoDevice:

  id of Galvo Controller

• downstreamSpectr1Device:

  Spectrometer 1 (FXE/SCS)

• upstreamSpectr1Device:

  Spectrometer 1 (SPB/SQS)

• currentExperiment:

  Current MASTER experiment (UPSTREAM or DOWNSTREAM)

• currentVersion:

  Current version

• correctionFactorMaster:

  Correction Factor Master

• correctionFactorSlave:

  Correction Factor Slave

• switchProgress:

  Switching Progress

• switchExperiment:

  Procedure to automatically swap between FXE and SPB delay control and Galvo settings

• on:

  Switch motor current On.

• off:

  Switch motor current Off.

• lastError:

  Last error message received. Time is set by front-end firmware.

• scpiTimeout:

  The SCPI communication timeout.

• baseFreq:

  dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

• frontendReset:

  send reset command

• s7ack:

  acknowledge to s7 command

• s8ack:

  acknowledge to s8 command

• s9ack:

  acknowledge to s9 command

• laserEmission:

  True when laser ON, false when OFF

• generalStatus:

  True = OK, False = not OK

• temperatureStatus:

  True = OK, False = not OK

• delayBoardStatus:

  True = OK, False = not OK

• inputPin0Status:

  True = OK, False = not OK

• inputPin4Status:

  True = OK, False = not OK

• pd1Voltage:

  Photodiode 1 (TAB 2) voltage

• pd1VoltageAverage:

  Averaged PD1 (TAB 2) voltage

• pd2Voltage:

  Photodiode 2 (TAB 5) voltage

• pd2VoltageAverage:

  Averaged PD2 (TAB 5) voltage

• pd3Voltage:

  PD3 (SPCO 1) voltage

• pd3VoltageAverage:

  Averaged PD3 (SPCO 1) voltage

• pd4Voltage:

  PD4 (TAB 7) voltage

• pd4VoltageAverage:

  Averaged PD4 (TAB 7) voltage

• pd5Voltage:

  PD5 (SPCO2) voltage

• pd5VoltageAverage:

  Averaged PD5 (SPCO2) voltage

• pd6Voltage:

  PD6 voltage

• pd6VoltageAverage:

  Averaged PD6 voltage

• pd7Voltage:

  PD7 voltage

• pd7VoltageAverage:

  Averaged PD7 voltage

• pd8Voltage:

  PD8 voltage

• pd8VoltageAverage:

  Averaged PD8 voltage

• seederOutPower:

  photodiode 1

• xf1OutPower:

  Photodiode 7

• xf2OutPower:

  Photodiode 8

• seederStatus:

  True = OK, False = not OK

• generalSeederStatus:

  True = OK, False = not OK

• hiltiErrorStatus:

  True = OK, False = not OK

• remoteControl:

  if it is false we cannot see it

• regOnOff0:

  Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

• regOnOff1:

  Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

• setpAX0:

  Variable SetpAx[0] define the setpoint of the servo loop.

• setpAY0:

  Variable SetpAy[0] define the setpoint of the servo loop.

• sumA0:

  Sum signal of angle detector ‘A’

• sumB0:

  Sum signal of position detector ‘B’

• aX0:

  Variable Ax represents the measured angle deviation in x direction from zero position

• aY0:

  Variable Ay represents the measured angle deviation in y direction from zero position

• bX0:

  Variable Bx represents the measured position deviation in x direction from zero position

• bY0:

  Variable By represents the measured position deviation in y direction from zero position

• rAX0:

  Regulator Output Ax

• rAY0:

  Regulator Output Ay

• rBX0:

  Regulator Output Bx

• rBY0:

  Regulator Output By

• rAXM0:

  Regulator Output AxM

• rAYM0:

  Regulator Output AyM

• rBXM0:

  Regulator Output BxM

• rBYM0:

  Regulator Output ByM

• setpAX1:

  Variable SetpAx[1] define the setpoint of the servo loop.

• setpAY1:

  Variable SetpAy[1] define the setpoint of the servo loop.

• sumA1:

  Sum signal of angle detector ‘A’

• sumB1:

  Sum signal of position detector ‘B’

• aX1:

  Variable Ax represents the measured angle deviation in x direction from zero position

• aY1:

  Variable Ay represents the measured angle deviation in y direction from zero position

• bX1:

  Variable Bx represents the measured position deviation in x direction from zero position

• bY1:

  Variable By represents the measured position deviation in y direction from zero position

• rAX1:

  Regulator Output Ax

• rAY1:

  Regulator Output Ay

• rBX1:

  Regulator Output Bx

• rBY1:

  Regulator Output By

• rAXM1:

  Regulator Output AxM

• rAYM1:

  Regulator Output AyM

• rBXM1:

  Regulator Output BxM

• rBYM1:

  Regulator Output ByM

• stage1Id:

  Karabo device ID of first grating motor

• stage2Id:

  Karabo device ID of first grating motor

• tunnel:

  Location where doocs_device is deployed (e.g. ‘SASE1’)

• labx2MName:

  DOOCS name of X2 Master doocs_device

• labx2SName:

  DOOCS name of X2 Slave doocs_device

• timingShifterName:

  DOOCS name of Phase Shifter doocs_device

• manualTuning:

  Manual Tuning Enable

• useShifter:

  Set to True if optical synchronization is available

• midTsValue:

  Mid Value of Phase Shifter

• maxTsDelay:

  Maximum delay to add/subtract to phase shifter position

• maxTsJitter:

  Maximum allowed jitter

• laserOpModeList:

  Select Laser Op Mode

• activeLaserOpMode:

  Active Op laser Mode

• laserOpModeListApply:

  Apply Laser Operation Mode

• dmBCCAuto:

  Automatic loop on/off

• pCellState:

  Status of Pockels Cell, True = On

• pCellOn:

  Set Pockels cell on

• pCellOff:

  Set Pockels cell off

• AOMState:

  Status of AOM, True = On

• AOMOn:

  Set AOM on

• AOMOff:

  Set AOM off

• maxAllowedPcPhase:

  Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

• mPCCLKPhase:

  Master PC Phase

• mSWPCCLKPhase:

  Master SW PC Phase

• mBurstWidth:

  Master burst width [us]

• mBurstWidthApply:

  Apply m Burst Width

• mBurstStart:

  Begining of the bursts the slave burst is +50ms)

• mBurstStartsms:

  Master burst starts pos. [us]

• sBurstStartsms:

  Sleve burst starts pos. [us]

• smBurstDiff:

  Different between muster and slave burst positione

• sPCCLKPhase:

  Master PC Phase

• sSWPCCLKPhase:

  Slave software PC PHase

• sBurstWidth:

  Slave burst width [us]

• sBurstWidthApply:

  Apply S Burst width

• delayBPMaster:

  Current delay of the master bunch pattern in clock unit (machine)

• delayBPMasterP:

  Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

• delayBPMasterM:

  Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

• delayBPMasterP24:

  Increment Master Bunch Pattern delay by 24 clock unit

• delayBPMasterM24:

  Decrement Master Bunch Pattern delay by 24 clock unit

• delayBPSlave:

  Current delay of the slave bunch pattern in clock unit (machine)

• delayBPSlaveP:

  Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

• delayBPSlaveM:

  Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

• delayBPSlaveP24:

  Increment Slave Bunch Pattern delay by 24 clock unit

• delayBPSlaveM24:

  Decrement Slave Bunch Pattern delay by 24 clock unit

• masterExpPattern:

  Select pattern for master experiment

• slaveExpPattern:

  Select pattern for slave experiment

• currentLaserPatterns:

  Current Laser Patterns

• currentMasterLaserPattern:

  Current Master Laser Patterns

• currentSlaveLaserPattern:

  Current Slave Laser Patterns

• currentSlaveLaserPatternN:

  Current Slave Laser Pattern

• fineDelayMaxCounts:

  Fine delay - maximum count number

• fineDelayValue:

  fine delay count value

• fineDelayValueT:

  fine delay time value

• fineDelayP:

  Increment fine delay

• fineDelayM:

  Decrement fine delay

• fineDelay9nsChange:

  Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

• fineDelay9ns:

  Change Fine Delay by 9 ns

• minTsPosition:

  Minimum Timing Shifter Delay

• maxTsPosition:

  Maximum Timing Shifter Delay

• currentTsPosition:

  current value of time shifter position

• requestedTsDelay:

  Delay to apply to the phase shifter

• DelayTsChange:

  Change phase shifter by requested value

• relAbsolutTsPos:

  True for relative, False for absolute

• stopPsChange:

  Abort phase shift change

• opticalSynch:

  Display status of optical synchronization

• opticalSynchLock:

  Display lock status of optical synchronization

• opticalSynchJitter:

  Display status of optical synchronization jitter

• opticalSynchMode:

  Optical synch. mode (RF / Optical)

• setOpticalDelay:

  Delay to apply to optical delay line

• applyOpticalDelay:

  change the optical delay by requeste value

• currentOpticalDelay:

  Current position of optical delay

• relAbsolutDelayLine:

  True for relative, False for absolute

• TsJitter:

  Optical Synchronization Jitter

• triggerFE_DOWNSTREAM:

  Current trigger delay FE DOWNSTREAM

• triggerFE_UPSTREAM:

  Current trigger delay FE UPSTREAM

• getCurrentHardwareStatus:

  Read configuration from hardware

• lastShiftDelay:

  FE delay value from the prevoius shift

• setLastShiftDelay:

  Bring the delay to position from the previus shift

• clearLock:

  In case of STATE == changing bring the state to Normal

• mPCCLKPhaseSetValue:

  Master PC CLK Phase Value

• sPCCLKPhaseSetValue:

  Slave PC CLK Phase Value

• delayBPMasterSetValue:

  Master BP delay Value

• delayBPSlaveSetValue:

  Slave BP delay Value

• resetError:

  Reset error count.

• upstreamTimingDrifCompensatorId:

  Karabo ID of Timing Drift Compensator device for upstream instrument

• downstreamTimingDrifCompensatorId:

  Karabo ID of Timing Drift Compensator device for downstream instrument

• shiftChange:

  Swaps MASTER and SLAVE properties between upstream and downstream instrument

• isOxcActive:

  Status of optical lock (True: OPTICAL mode, False: RF mode)

• requestedDelay:

  Relative delay to be applied by delay change (Trigger Position)

• delayChange:

  Change delay value by applying (relative) offset

• mPCCLKPhaseP:

  Increment PC master Phase

• mPCCLKPhaseM:

  Decrement PC master Phase

• sPCCLKPhaseP:

  Increment slave PC Phase

• sPCCLKPhaseM:

  Decrement slave PC phase

• savemSWPCCLKPhase:

  Save new software phase value for PCm

• savesSWPCCLKPhase:

  Save new software phase value for PCs

• mBurstStartApply:

  Apply Burst Start Pos

• takemidTsValue:

  Take mid value of phase shifter

• logBoardsStatus:

  JSON string describing master and slave board settings.Usually updated when user actions are taken

• logFineDelay:

  JSON string describing fine delay settings.Usually updated when user actions are taken

• imgprocDevice:

  Device ID of image processor used for feedback

• temDevice:

  id of tem device

• temChannel:

  TEM channel to be controlled

• xCoefWeight:

  weight of X coefficient

• yCoefWeight:

  weight of Y coefficient

• axCoefOld:

  Value of Ax Coefficient saved prior to calibration

• ayCoefOld:

  Value of Ay Coefficient saved prior to calibration

• xBeamCenterTarget:

  desired value for Beam Center X coordinate

• yBeamCenterTarget:

  desired value for Beam Center Y coordinate

• beamCenterMaxDisplacement:

  maximum allowed displacement for Center of Mass from target position

• maxTemDrift:

  Maximum value allowed for TEM drift

• averageNumber:

  number of values of beam center coordinates to average

• timeoutImageProcessorValues:

  Time to wait before going in error when values from image processor are not updating

• imageSettlementTime:

  Time to wait before reading beam center coordinates aftermoving TEM setpoint

• calibrationStep:

  TEM setpoint step size for calibration

• calibrationStepsNumber:

  Number of TEM calibration steps

• maxTimeNotRegulating:

  When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

• setCurrentPosAsTarget:

  Set current beam position as target

• pwmFrequency:
• pwmDutyCycle:

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

• enableLatchInternal:

  Enables the storage of the value of the scale latched to the internal reference

• enableLatchExternal:

  Enables the storage of the value of the scale latched to the external reference

• adcValue:

  The integer value read out by the encoder

• factor:

  Calibration factor to target unit

• setCounter16:

  Set value for 16 bit encoder.

• setCounter32:

  Set value for 32 bit encoder.

• ssiCoding:

  Binary coding or grey coding. False - Binary; True - Grey

• ssiFrameType:

  Length of the SSI data frame.

• ssiFrameSize:

  Not documented.

• ssiDataLength:

  Not documented.

• cppServerId:

  The cppServer where the beckhoffCom is running on

• beckhoffId:

  The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.

• blacklist:

  These devices won’t be instantiated etc.

• groups:

  The available component groups

• components:

  The available components

• instantiateWait:

  The deviceId of beckhoffCom to monitor

• availableScenes:

  Autogenerated scenes for the device.

• timeoutConnectToBCom:

  Timeout for succesfully connect to PLC

• timeoutReadDevConfig:

  Timeout for getting the same number of failures when reading the configuration of devices

• setDefaultDevConfig:

  Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

• outputFileRoot:

  Template string for output XML file

• inputFileTemplate:

  File with variables to save in FW

• configDir:

  Folder to store configuration files

• plcInFwTemplate:

  List of PLCs which have a specific configuration to save, as found in the FW Template

• instantiateDevices:

  Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.

• instantiateQuick:

  Instantiate all devices on selected PLC quickly

• instantiateGroupDevices:

  Instantiate all selected group devices in selected PLC

• instantiateComponentDevices:

  Instantiate all selected component devices in selectedPLC

• resetDevices:

  Reset all devices in Error state

• getOfflineDevices:

  Check which devices are still offline

• shutdownDevices:

  Shutdown all devices

• shutdownGroupDevices:

  Shutdown all group devices

• shutdownComponentDevices:

  Shutdown all component devices

• getPLCsInFwTemplate:

  Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

• getPLCsInSystem:

  Get list of PLCs active in current topic

• handleMultiConfigToXML:

  The retrieved config of devices in PLCs is written on an XML file

• handleSingleConfigToXML:

  The retrieved config of devices in selected beckhoffId is written in XML file

• cameraClasses:

  Camera classes to be considered

• timeout:

  After that camera is stuck for this long, its watchdog takes action

• maxAttempts:

  After this number of consecutive attempts to recover, the device goes in error state

• cameras:

  Cameras in topology

• collectiveAlarm:

  Global alarm, set when at least one of devices is not ON

• guideAlarm:

  Global alarm, set when at least one of devices is not ON

• flowAlarm:

  Alarm set when the water level is below threshold

• pressureAlarm:

  Alarm set water pressure is outside nominal range

• temperatureAlarm:

  Alarm set when water temperature is above critical value

• levelAlarm:

  Alarm set when water leve is below threshold

• doocsTimerCentral:

  Doocs address of central timer

• doocsX2Master:

  Doocs address of X2 master board

• doocsX2Slave:

  Doocs address of X2 slave board

• timeServer:

  Time Server device ID

• instrument:

  Instrument data refers to

• isMaster:

  Active experiment is the master. When instrument is slavePPL data are not relevant

• triggerDelay:

  The trigger delay with respect to T0 master trigger.

• serverOfDevice:

  The server running the selected device.

• classOfDevice:

  The class of the selected device.

• actionOfDevice:

  Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.

• awaitedStateOfDevice:

  Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.

• configurationOfDevice:

  Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.

• cancelDeviceAddition:

  The current selection of device configuration is canceled.

• persistConfig:

  The active list of devices configuration is saved for future use.

• jobTimeout:

  Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.

• autoStart:

  Automatic start of devices at instantiation

• interfaces:

  Abstract interface for external proxies to be considered when working with this device

• home:

  Start homing procedure.

• move:

  Move to target position.

• stepUp:

  Move to actual position plus step length.

• stepDown:

  Move to actual position minus step length.

• calibrateTarget:

  The motor scale is set to this position when hitting calibrate

• isOnTarget:

  Indicates whether the motor is on target or not.

• actualPosition:

  Actual position of the motor. If an encoder is activated, this represents the encoder position.

• stepCounterPosition:

  Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.

• targetPosition:

  Target position in position mode.

• targetVelocity:

  Target velocity in velocity mode.

• modus:

  Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.

• masterMotor:

  Define master motor for master/slave operation mode.

• stepLength:

  Step length used in StepUp/StepDown.

• isIdleOpenLoop:

  True - Stopped on target; False - Idle on target (follows encoder position).

• isCWLimit:

  Is at hardware end-switch high - CW limit.

• isCCWLimit:

  Is at hardware end-switch low - CCW limit.

• isSWLimitHigh:

  Is at software limit high.

• isSWLimitLow:

  Is at software limit low.

• isInterlockLimitHigh:

  Is at interlock limit high.

• isInterlockLimitLow:

  Is at interlock limit low.

• isSlave:

  The motor is configured as slave in a coordinated motion.

• masterSlaveCorrelation:

  The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).

• gear:

  Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.

• encodeStep:

  Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].

• deadband:

  Within deadband the motor is on target.

• pConst:

  Proportional feedback constant.

• aMax:

  Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).

• acceleration:

  Maximum velocity difference in [targetUnit/s^2].

• vMax:

  Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).

• velocity:

  Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).

• vMin:

  Minimum velocity expressed in arbitrary terminal units/cycle.

• limitPosL:

  Software limit low.

• limitPosH:

  Software limit high.

• invLogicLim1:

  Limit switch 1 logic: False - active high ; True - active low.

• invLogicLim2:

  Limit switch 2 logic: False - active high ; True - active low.

• isInvertLimits:

  Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).

• isInternalCounter:

  False - No step counter in terminal available; True - Internal counter from terminalis used.

• maxCurrent:

  Maximum motor current.

• reducedCurrent:

  Reduced current, when Idle or stopped - Holding current.

• backlash:

  Backlash distance. ONLY valid in modus 2.

• plcCycleAveraging:

  Number of PLC Cycles after which the averaged encoder value is sent out.

• isLimitless:

  Set to True for limit less axes - e.g. filter wheels.

• homeUp:

  False - default homing searches down for a home switch; True - will search up for a home switch instead.

• homeNoLimit:

  False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.

• saveLimitPosition:

  Save Hardware limit position to the soft limit position.

• checkLimitConsistency:

  Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.

• terminalTemperature:

  Terminal Temperature.

• controllerVoltage:

  Voltage of the controller section of the terminal.

• motorDriverVoltage:

  Voltage of the motor driver.

• syncEncoder:

  True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.

• extEncoderEnabled:

  True - Use external encoder; False - Don’t use external encoder for position reference.

• extEncoderName:

  Declare device name for external encoder.

• relativeDeadband:

  if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

• serverUri:

  URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.

• serverTimeout:

  Timeout for server responses.

• autoResetTime:

  Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.

• connectionSettlingTime:

  Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number

• failedConnectionAttempts:

  Number of consecutive attempts to connect

• plcUptime:

  Total time (in seconds), that the PLC server is up and running

• createGenericDevices:

  If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.

• messageRateOut:

  The average rate of messages sent by BeckhoffCom

• messageRateIn:

  The average rate of messages received by BeckhoffCom

• byteRateOut:

  The average rate of bytes sent by BeckhoffCom

• byteRateIn:

  The average rate of bytes received by BeckhoffCom

• availablePlcDevices:

  Lists all available PLC devices

• updatesRate:

  The average rate of updates to the Beckhoff Devices

• devicesBlacklist:

  List of the devices that will not be instantiated automatically.

• instantiationInterval:

  The interval between consecutive instantiations

• ACpuFrequency:

  Frequency of the CPU.

• ACurrentCpuUsage:

  Current CPU usage.

• ACurrentCpuTemperature:

  Current temperature of the CPU.

• AProgramMemoryAllocated:

  Allocated program memory.

• AProgramMemoryAvailable:

  Available program memory.

• AStorageMemoryAllocated:

  Allocated storage-memory. Available on Windows CE.

• AStorageMemoryAvailable:

  Available storage-memory. Available on Windows CE.

• AMemoryDivision:

  MemoryDivision. Available on Windows CE.

• AProgramMemoryAllocated2:

  Allocated program memory.

• AProgramMemoryAvailable2:

  Available program memory.

• AMacAddess:

  MAC-Address of the PLC (17 char string).

• AIpv4Address:

  Current IPv4 Address of the PLC in dotted notation (15 char string).

• AIpv4SubnetMask:

  IPv4 subnet mask of the PLC in dotted notation (15 char string).

• ADhcpServerIpv4Address:

  IP-Address of the DHCP-Server in dotted notation (15 char string).

• ADhcpServerEnabled:

  True if the DHCP-Server is enabled.

• AMainboardType:

  Type of the main-board.

• ASerialNumber:

  Serial number.

• AProductionDate:

  Production date of the main-board.

• ABootCount:

  Boot count.

• AOperatingTimeInMinutes:

  Operating time of the main-board.

• AMinBoardTemperature:

  Minimum temperature of the main-board.

• AMaxBoardTemperature:

  Maximum temperature of the main-board.

• MinInputVoltage:

  Minimum input voltage of the main-board.

• MaxInputVoltage:

  Maximum input voltage of the main-board.

• MainboardTemperature:

  Current temperature of the main-board.

• APlcProjectVersion:

  PLC Project Version

• AProjectGeneratorVersion:

  Project Generator Version

• ATCPBufferSize:

  TCP/IP buffer size.

• ATrainID:

  Train ID

• ABeamModes:

  Beam Modes

• ATCPOutputDataRate:

  TCP Output Data Rate

• ATCPOutputBufLvlMax:

  TCP Output Buf Lvl Max

• ATCPInputDataRate:

  TCP Input Data Rate

• ATCPInputBufLvlMax:

  TCP Input Buf Lvl Max

• APLCCycleTime:

  PLC Cycle Time

• inFrameRate:

  The input frame rate.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 peak position from 1D fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 peak position from 1D fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 peak position from 2D fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 peak position from 2D fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created:

2019-02-12T09:02:33.000Z

Author:

Andrea Parenti

Notes:

• Only log first 5 errors in TwoPeakFinder
• Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created:2019-02-01T15:13:24.000Z Author:Cyril Danilevski Notes:Add twin peak finder

1.15.0-2.3.2

Created:

2019-01-31T10:18:10.000Z

Author:

Andrea Parenti

Notes:

• ADD interfaces to all devices
• FIX ImageToSpectrum and ImageNormRoi for K2.3
• FIX states for K2.3 - now ON/PROCESSING

NOPA_SPB_1

Instance id:LA1_LAS_PPL/PROC/NOPA_SPB_1 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/NOPA_SPB_1, LA1_LAS_PPL/CAM/NOPA_SPB_1, LA1_LAS_PPL/CAM/NOPA_SPB_1, SPB 1st stage, SPB 1st stage, SPB 1st stage Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_SPB_2

Instance id:LA1_LAS_PPL/PROC/NOPA_SPB_2 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:SPB user panel, SPB status scene, SPB user panel, SPB 2nd stage, SPB status scene, NOPA SPB, PPL_NOPA_SPB_OVERVIEW, SPB 2nd stage Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_SPB_3

Instance id:LA1_LAS_PPL/PROC/NOPA_SPB_3 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

NOPA_SPB_SEED

Instance id:LA1_LAS_PPL/PROC/NOPA_SPB_SEED Host:exflcon70n0 Class documentation:  ImageProcessor Alias:la1-gui2 , la1-rr-ppl-con-2 , la1-rr-sys-con-gui2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-03-17T11:23:32.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Giovanetti Latest tag:1.27.1-2.8.0 Deployment tag:1.27.1-2.8.0 Installed tag:1.27.1-2.8.0 Scenes:TEM XF2 SPB-FXE, TEM XF2 SPB-FXE incl setpoints0 Accessible by:CAL, CONTROLS, DA, WP78, brambrin, pallasf

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Release History

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created:

2019-02-12T09:02:33.000Z

Author:

Andrea Parenti

Notes:

• Only log first 5 errors in TwoPeakFinder
• Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created:2019-02-01T15:13:24.000Z Author:Cyril Danilevski Notes:Add twin peak finder

1.15.0-2.3.2

Created:

2019-01-31T10:18:10.000Z

Author:

Andrea Parenti

Notes:

• ADD interfaces to all devices
• FIX ImageToSpectrum and ImageNormRoi for K2.3
• FIX states for K2.3 - now ON/PROCESSING

SPB_DIAG

Instance id:LA1_LAS_PPL/PROC/SPB_DIAG Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/SPB_DIAG, LA1_LAS_PPL/CAM/SPB_DIAG, XF1-SPB cams, LA1_LAS_PPL/CAM/SPB_DIAG, XF1-SPB cams Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

SPB_Instr_1

Instance id:LA1_LAS_PPL/PROC/SPB_Instr_1 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

SPB_Instr_2

Instance id:LA1_LAS_PPL/PROC/SPB_Instr_2 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

SPB_Instr_3

Instance id:LA1_LAS_PPL/PROC/SPB_Instr_3 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Projects:LA1_LAS_PPL_20180720_BAK Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

SPB_UNCOMP

Instance id:LA1_LAS_PPL/PROC/SPB_UNCOMP Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-07-31T11:50:20.000+02:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Fabbri, Giovanetti Latest tag:1.27.4-2.9.1 Deployment tag:1.27.4-2.9.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:SPB-1030-Status-Scene, SPB 1030 Beam Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

XF1FE_DIAG_PROC

Instance id:LA1_LAS_PPL/PROC/XF1FE_DIAG_PROC Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-07-31T11:50:20.000+02:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Fabbri, Giovanetti Latest tag:1.27.4-2.9.1 Deployment tag:1.27.4-2.9.1 Projects:XF1 FE Diagnostic, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/CAM/XF1FE_DIAG, GGtest_imgproc, (Amphos seed cameras_OLD), LA1_LAS_PPL/CAM/XF1FE_DIAG, (Amphos seed cameras_OLD), Amphos Input Cams 1DGauss, GGtest_imgproc, beam properties, LA1_LAS_PPL/CAM/XF1FE_DIAG Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 peak position from 1D fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 peak position from 1D fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 peak position from 2D fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 peak position from 2D fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

NOPA_SPB_11

Instance id:LA1_LAS_PPL/PROC/NOPA_SPB_11 Host:exflcon70n0 Class documentation:  ImageProcessor Alias:la1-gui2 , la1-rr-ppl-con-2 , la1-rr-sys-con-gui2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-03-17T11:23:32.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Giovanetti Latest tag:1.27.1-2.8.0 Deployment tag:1.25.0-2.6.2 Installed tag:1.25.0-2.6.2 Accessible by:CAL, CONTROLS, DA, WP78, brambrin, pallasf

[add instance documentation]

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Release History

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created:

2019-02-12T09:02:33.000Z

Author:

Andrea Parenti

Notes:

• Only log first 5 errors in TwoPeakFinder
• Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created:2019-02-01T15:13:24.000Z Author:Cyril Danilevski Notes:Add twin peak finder

1.15.0-2.3.2

Created:

2019-01-31T10:18:10.000Z

Author:

Andrea Parenti

Notes:

• ADD interfaces to all devices
• FIX ImageToSpectrum and ImageNormRoi for K2.3
• FIX states for K2.3 - now ON/PROCESSING

AMPHOS_NF

Instance id:LA1_LAS_PPL/PROC/AMPHOS_NF Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:Amphos Diagnostic cameras Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FE_XF1_FF

Instance id:LA1_LAS_PPL/PROC/FE_XF1_FF Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:Amphos Input Cams 1DGauss, FE_XF1-Cam-Images, FE_XF1-Pointing Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

AC_SPB_DIAG

Instance id:LA1_LAS_PPL/PROC/AC_SPB_DIAG Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

AMPHOS_FF

Instance id:LA1_LAS_PPL/PROC/AMPHOS_FF Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:Amphos Diagnostic cameras Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

AMPHOS_INPUT_NF

Instance id:LA1_LAS_PPL/PROC/AMPHOS_INPUT_NF Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Scenes:Amphos Input NF, FE_XF1-Cam-Images, FE_XF1-Pointing Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

BOBCAT

Instance id:LA1_LAS_PPL/PROC/BOBCAT Class id:ImageProcessor Host:exflcon205 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-07-31T11:50:20.000+02:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Fabbri, Giovanetti Latest tag:1.27.4-2.9.1 Deployment tag:1.27.4-2.9.1 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 peak position from 1D fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 peak position from 1D fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 peak position from 2D fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 peak position from 2D fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created:2019-02-19T12:53:14.000Z Author:Andrea Parenti Notes:Add ROI to the TwoPeakFinder device

AC_XF2_DIAG

Instance id:LA1_LAS_PPL/PROC/AC_XF2_DIAG Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FXE_1030

Instance id:LA1_LAS_PPL/PROC/FXE_1030 Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

SPB_1030

Instance id:LA1_LAS_PPL/PROC/SPB_1030 Class id:ImageProcessor Host:exflcon215 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-3 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

FXE_Instr_3

Instance id:LA1_LAS_PPL/PROC/FXE_Instr_3 Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

XF1DIAG_SPB_TEM

Instance id:LA1_LAS_PPL/PROC/XF1DIAG_SPB_TEM Class id:ImageProcessor Host:exflcon216 Class documentation:  ImageProcessor Alias:la1-rr-ppl-con-2 Git repo:https://git.xfel.eu/gitlab/karaboDevices/imageProcessor Last modified:2020-11-23T12:51:25.000+01:00 Created at:2016-11-16T14:12:17.000+01:00 Main authors:Parenti, Hauf, Fabbri Latest tag:1.27.4-2.10.0 Deployment tag:1.27.4-2.10.0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The ImageProcessor device is documented in imageprocessor:image-processor-user

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• inFrameRate:

  The input frame rate.

• resetError:

  Reset error count.

• reset:

  Resets the processor output values.

• useAsBackgroundImage:

  Use the current image as background image.

• imagePath:

  Input image path.

• filterImagesByThreshold:

  If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

• imageThreshold:

  The threshold for processing an image.

• absolutePositions:

  If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

• subtractBkgImage:

  Subtract the loaded background image.

• subtractImagePedestal:

  Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

• doMinMaxMean:

  Get the following information from the pixels: min, max, mean value.

• doBinCount:

  Calculate the frequency distribution of pixel values.

• doXYSum:

  Integrate the image along the x- and y-axes.

• doCOfM:

  Calculate centre-of-mass and widths.

• do1DFit:

  Perform a 1D gaussian fit of the x- and y-distributions.

• do2DFit:

  Perform a 2D gaussian fits.Be careful: It can be slow!

• doIntegration:

  Perform integration over region.

• clipValues:

  Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

• comRange:

  The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

• userDefinedRange:

  The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• absThreshold:

  Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

• threshold:

  Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

• pixelSize:

  The pixel size. It will be used when evaluating the beam size.

• fitRange:

  The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

• rangeForAuto:

  The automatic range for ‘auto’ mode (in standard deviations).

• enablePolynomial:

  Add a 1st order polynomial term (ramp) to gaussian fits.

• gauss1dStartValues:

  Selects how 1D gauss fit starting values are evaluated

• doGaussRotation:

  Allow the 2D gaussian to be rotated.

• integrationRegion:

  The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

• thresholdRange:

  Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

• imageWidth:

  The width of the incoming image.

• imageOffsetX:

  If the incoming image has a ROI, this represents the X position of the top-left corner.

• imageBinningX:

  The image binning in the X direction.

• imageHeight:

  The height of the incoming image. Set to 1 for 1D images (spectra).

• imageOffsetY:

  If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

• imageBinningY:

  The image binning in the Y direction. Set to 1 for 1D images (spectra).

• minPxValue:

  The minimum image pixel value.

• maxPxValue:

  The maximum image pixel value.

• meanPxValue:

  The mean image pixel value.

• minMaxMeanTime:

  Time spent for evaluating min, max, mean pixel value.

• binCountTime:

  Time spent for calculating the frequency distribution of pixel values.

• subtractBkgImageTime:

  Time spent in subtracting the background image.

• subtractPedestalTime:

  Time spent in subtracting the image pedestal.

• xYSumTime:

  Time spent in integrating the image in X and Y.

• cOfMTime:

  Time spent in evaluating the centre-of-mass.

• xFitTime:

  Time spent in 1D Gaussian fit of the X distribution.

• yFitTime:

  Time spent in 1D Gaussian fit of the Y distribution.

• fitTime:

  Time spent in 2D Gaussian fit of the image.

• integrationTime:

  Time spent in integrating over a region.

• x0:

  X position of the centre-of-mass.

• sx:

  Standard deviation in X of the centre-of-mass.

• y0:

  Y position of the centre-of-mass.

• sy:

  Standard deviation in Y of the centre-of-mass.

• xFitSuccess:

  1D Gaussian fit success (1-4 if fit converged).

• ax1d:

  Amplitude Ax from the 1D fit.

• x01d:

  x0 from 1D Fit.

• ex01d:

  Uncertainty on x0 estimation.

• sx1d:

  Standard deviation on x0 from 1D fit.

• esx1d:

  Uncertainty on standard deviation estimation.

• beamWidth1d:

  Beam width from 1D Fit. Defined as 4x sigma_x.

• yFitSuccess:

  1D Gaussian Fit Success (1-4 if fit converged).

• ay1d:

  Amplitude Ay from 1D fit.

• y01d:

  y0 from 1D Fit.

• ey01d:

  Uncertainty on y0 estimation.

• sy1d:

  Standard deviation on y0 from 1D fit.

• esy1d:

  Uncertainty on standard deviation estimation.

• beamHeight1d:

  Beam heigth from 1D Fit. Defined as 4x sigma_y.

• fitSuccess:

  2D Gaussian fit success (1-4 if fit converged).

• a2d:

  Amplitude from 2D fit.

• x02d:

  x0 from 2D Fit.

• ex02d:

  Uncertainty on x0 estimation.

• sx2d:

  Standard deviation on x0 from 2D fit.

• esx2d:

  Uncertainty on standard deviation estimation.

• beamWidth2d:

  Beam width from 2D Fit. Defined as 4x sigma_x.

• y02d:

  y0 from 2D Fit.

• ey02d:

  Uncertainty on y0 estimation.

• sy2d:

  Standard deviation on y0 from 2D fit.

• esy2d:

  Uncertainty on standard deviation estimation.

• beamHeight2d:

  Beam height from 2D Fit. Defined as 4x sigma_y.

• theta2d:

  Rotation angle from 2D fit.

• etheta2d:

  Uncertainty on rotation angle estimation.

• regionIntegral:

  Integral of pixel value over region specified by integrationRegion.

• regionMean:

  Mean pixel value over region specified by integrationRegion.

Release History

1.27.4-2.10.0

Created:2020-11-23T11:51:09.000Z Author:Gabriele Giovanetti Notes:Karabo 2.10 versioning

1.27.4-2.9.1

Created:2020-07-30T12:29:13.000Z Author:Andrea Parenti Notes:Reset properties only once

1.27.3-2.9.1

Created:2020-07-28T12:08:55.000Z Author:Andrea Parenti Notes:Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created:2020-07-06T11:53:30.000Z Author:Riccardo Fabbri Notes:Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created:2020-03-17T10:23:50.000Z Author:Andrea Parenti Notes:Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created:2020-03-12T15:58:22.000Z Author:Andrea Parenti Notes:Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created:2019-12-10T13:13:22.000Z Author:Andrea Parenti Notes:Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created:2019-09-25T07:12:39.000Z Author:Andrea Parenti Notes:ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created:2019-09-17T15:59:16.000Z Author:Robert Schaffer Notes:Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created:2019-09-05T15:06:43.000Z Author:Robert Schaffer Notes:Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created:2019-09-04T12:46:06.000Z Author:Andrea Parenti Notes:FIX 1D data ImageAverager

1.24.0-2.5.1

Created:2019-08-22T14:57:59.000Z Author:Cyril Danilevski Notes:Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created:2019-07-10T07:31:19.000Z Author:Andrea Parenti Notes:FIX processing of spectra

1.23.1-2.5.0

Created:2019-07-05T14:19:56.000Z Author:Gabriele Giovanetti Notes:

1.23.0-2.5

Created:

2019-07-01T08:20:28.000Z

Author:

Gabriele Giovanetti

Notes:

• WARNING: this tag is not to be used with Karabo version < 2.5 *

• Improved Error state handling
• 1d images (spectra) processing
• Fix for empty auto-range

1.22.0-2.4.2

Created:2019-06-18T11:41:45.000Z Author:Andrea Parenti Notes:Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created:2019-05-09T14:59:33.000Z Author:Andrea Parenti Notes:Adding option for lightweight exponential running average

1.20.0-2.4.0

Created:2019-04-30T12:34:21.000Z Author:Robert Schaffer Notes:Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created:2019-03-26T17:58:39.000Z Author:Wajid Ehsan Notes:Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created:

2019-02-21T09:22:07.000Z

Author:

Andrea Parenti

Notes:

• add ImageBackgroundSubtraction device;
• add documentation for TwoPeakFinder.

BEAM_TEST

FE_XF1_FFnew

PUMP

[add component documentation]

PUMP_BEAMPIPES_STATUS

Instance id:LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_STATUS Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_STATUS, LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_STATUS, LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_STATUS Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

PUMP_BEAMPIPES_ON_OFF

Instance id:LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_ON_OFF Class id:BeckhoffDigitalOutput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalOutput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_ON_OFF, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_ON_OFF, Vacuum Monitoring, LA1_LAS_PPL/VACUMM/CONTROL|default, LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_ON_OFF, Vacuum Monitoring, Vacuum-Monitoring, Vacuum Monitoring, LA1_LAS_PPL/VACUUM/CONTROL|default, LA1_LAS_PPL/VACUUM/CONTROL|default Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• on:

  Instructs the device to switch on

• off:

  Instructs device to switch off

• pwmCycleLimit:

  Number Of PWM Cycles, 0 = inifite number of cycles

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

SPECPROC

[add component documentation]

SEEDER_SPECTROMETER

NOPA_FXE_1

NOPA_FXE_2

NOPA_FXE_3

NOPA_SPB_1

NOPA_SPB_2

NOPA_SPB_3

SPECT

[add component documentation]

SEEDER_SPECTROMETER

NOPA_FXE_1

NOPA_FXE_2

NOPA_FXE_3

NOPA_SPB_1

NOPA_SPB_2

NOPA_SPB_3

SWITCH

[add component documentation]

LABCHL_ALARM_WATERLEVEL

Instance id:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_WATERLEVEL Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_WATERLEVEL, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_WATERLEVEL, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_WATERLEVEL Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LABCHL_ALARM_COLLECTIVE

Instance id:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_COLLECTIVE Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Scenes:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_COLLECTIVE , LA1_LAS_PPL/SWITCH/LABCHL_ALARM_COLLECTIVE , LA1_LAS_PPL/SWITCH/LABCHL_ALARM_COLLECTIVE Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LABCHL_ALARM_FLOW_1

Instance id:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_FLOW_1 Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_FLOW_1, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_FLOW_1, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_FLOW_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LABCHL_ALARM_GUIDE_VALUE

Instance id:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_GUIDE_VALUE Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_GUIDE_VALUE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_GUIDE_VALUE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_GUIDE_VALUE Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LABCHL_ALARM_PRESSURE

Instance id:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_PRESSURE Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_PRESSURE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_PRESSURE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_PRESSURE Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

LABCHL_ALARM_TEMPERATURE

Instance id:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_TEMPERATURE Class id:BeckhoffDigitalInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffDigitalInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/SWITCH/LABCHL_ALARM_TEMPERATURE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_TEMPERATURE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_TEMPERATURE Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The BeckhoffDigitalInput device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• invert:

  If set, the digital value as received from the hardware is inverted.

• edgeCount:

  Counter of the input edges

• fallingEdgeCounter:

  True - Counter On Falling Edge; False - Counter on Raising Edge.

• resetCounter:

  Reset count of edges

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

CHILLER

TSENS

[add component documentation]

TEMP_TABLE_8

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_8 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_8, LA1_LAS_PPL/TSENS/TEMP_TABLE_8, LA1_LAS_PPL/TSENS/TEMP_TABLE_8 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMPERATURE

Instance id:LA1_LAS_PPL/TSENS/TEMPERATURE Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMPERATURE, PP_layout_karaboo, All in 1, Temperature and Humidity, All in 1, Temperature and Humidity, LA1_LAS_PPL/TSENS/TEMPERATURE, Temperature and Humidity, All in 1, TEM XF2 SPB-FXE, Overview, PPL_OVERVIEW, LA1_LAS_PPL/TSENS/TEMPERATURE, Temperature and Humidity, TEM XF2 SPB-FXE, All in 1, Overview_new0, PP_layout_karaboo_V5, PP_layout_karaboo_V6, PP_layout_karaboo_V7, PP_layout_karaboo_V8, PP_layout_karabo, PP_layout_karabo, Temperature and Humidity, PP_layout_karaboo_V3.svg.2018_11_21_10_15_46.0 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_1

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_1 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_1, LA1_LAS_PPL/TSENS/TEMP_EQUIP_1, LA1_LAS_PPL/TSENS/TEMP_EQUIP_1 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_2

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_2 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:Galvo, LA1_LAS_PPL_20180720_BAK, Galvo, LA1_LAS_PPL_20180720_BAK, Galvo, Galvo Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_2, LA1_LAS_PPL/TSENS/TEMP_EQUIP_2, Temperatures, Temperatures, LA1_LAS_PPL/TSENS/TEMP_EQUIP_2, Temperatures, Temperatures, Temperatures Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_3

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_3 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_3, LA1_LAS_PPL/TSENS/TEMP_EQUIP_3, LA1_LAS_PPL/TSENS/TEMP_EQUIP_3 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_4

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_4 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_4, LA1_LAS_PPL/TSENS/TEMP_EQUIP_4, LA1_LAS_PPL/TSENS/TEMP_EQUIP_4 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_5

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_5 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_5, LA1_LAS_PPL/TSENS/TEMP_EQUIP_5, LA1_LAS_PPL/TSENS/TEMP_EQUIP_5 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_6

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_6 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_6, LA1_LAS_PPL/TSENS/TEMP_EQUIP_6, LA1_LAS_PPL/TSENS/TEMP_EQUIP_6 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_7

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_7 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_7, LA1_LAS_PPL/TSENS/TEMP_EQUIP_7, LA1_LAS_PPL/TSENS/TEMP_EQUIP_7 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_EQUIP_8

Instance id:LA1_LAS_PPL/TSENS/TEMP_EQUIP_8 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_EQUIP_8, LA1_LAS_PPL/TSENS/TEMP_EQUIP_8, LA1_LAS_PPL/TSENS/TEMP_EQUIP_8 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_1

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_1 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, Temperature and Humidity, Temperature and Humidity Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_1, All in 1, Table temperatures, All in 1, Table temperatures, LA1_LAS_PPL/TSENS/TEMP_TABLE_1, Table temperatures, All in 1, LA1_LAS_PPL/TSENS/TEMP_TABLE_1, Temperature around Amphos, Table temperatures, All in 1, Temperature around Amphos, Table temperatures Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_2

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_2 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, Temperature and Humidity, Temperature and Humidity Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_2, All in 1, Table temperatures, All in 1, Table temperatures, Table temperatures, All in 1, LA1_LAS_PPL/TSENS/TEMP_TABLE_2, Temperature around Amphos, Table temperatures, All in 1, Temperature around Amphos, Table temperatures, LA1_LAS_PPL/TSENS/TEMP_TABLE_2 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_3

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_3 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:Temperature and Humidity, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, XF1 FE Diagnostic, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_3, All in 1, Table temperatures, All in 1, Table temperatures, LA1_LAS_PPL/TSENS/TEMP_TABLE_3, Temperature @ FE, Table temperatures, All in 1, Temperature @ FE, LA1_LAS_PPL/TSENS/TEMP_TABLE_3, Table temperatures, All in 1, Table temperatures Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_4

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_4 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:Temperature and Humidity, Temperature and Humidity, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_4, All in 1, Temperature under seeder box, Table temperatures, All in 1, Temperature under seeder box, Table temperatures, LA1_LAS_PPL/TSENS/TEMP_TABLE_4, Temperature under seeder box, Table temperatures, All in 1, LA1_LAS_PPL/TSENS/TEMP_TABLE_4, Temperature under seeder box, Table temperatures, All in 1, Temperature under seeder box, Table temperatures Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_5

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_5 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_5, All in 1, Table temperatures, All in 1, Table temperatures, LA1_LAS_PPL/TSENS/TEMP_TABLE_5, Table temperatures, All in 1, LA1_LAS_PPL/TSENS/TEMP_TABLE_5, Table temperatures, All in 1, Table temperatures Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_6

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_6 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_6, LA1_LAS_PPL/TSENS/TEMP_TABLE_6, LA1_LAS_PPL/TSENS/TEMP_TABLE_6 Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TEMP_TABLE_7

Instance id:LA1_LAS_PPL/TSENS/TEMP_TABLE_7 Class id:BeckhoffAnalogInput Host:la1-rr-ppl-con-1 Class documentation:  BeckhoffAnalogInput General:link Monitor:link Developer:link PLC:link Alias:la1-rr-ppl-con-1 Git repo:https://git.xfel.eu/karaboDevices/Beckhoff Last modified:2021-10-07T15:11:02.053+02:00 Created at:2017-07-20T11:58:15.000+02:00 Main authors:Mamchykd, Silenzi, Giovanetti Latest tag:4.8.2-2.11.1rc1 Deployment tag:4.8.2-2.11.1rc1 Installed tag:4.6.4-2.11.1 Projects:LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, LA1_LAS_PPL_20180720_BAK, Temperature and Humidity, Temperature and Humidity Scenes:LA1_LAS_PPL/TSENS/TEMP_TABLE_7, All in 1, Table temperatures, All in 1, Table temperatures, LA1_LAS_PPL/TSENS/TEMP_TABLE_7, Table temperatures, All in 1, LA1_LAS_PPL/TSENS/TEMP_TABLE_7, All in 1, Table temperatures Accessible by:CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The BeckhoffAnalogInput device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• beckhoffComDevice:

  InstanceId of the BeckhoffCom device that forwards commands to the PLC.

• functionBlockName:

  The type of the firmware block.

• fwInstanceName:

  The name of the firmware block instance.

• fwVersion:

  The version of the PLC framework.

• terminal:

  ???

• hardwareStatusBitField:

  This word encodes in bits the hardware-status information of this device

• hardwareState:

  The current state of the hardware decoded

• hardwareRegion:

  The current region of the hardware decoded

• hardwareErrorDescriptor:

  This word encodes in bits describing the hardware error

• hardwareErrorDescription:

  Error Code description

• waitingFor:

  Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

• epsilon:

  The epsilon determines the amount of change until a new physical value is posted from the hardware

• interlockReadOnly:

  Defines whether interlock conditions are configurable from this interface.

• interlockOn:

  Defines whether interlock surveillance is on or off.

• interlockOk:

  Defines whether interlock is ok (true) or broken (false).

• busy:

  Defines whether the PLC softdevice is busy.

• disableEpsilonFeedback:

  If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

• maxStateUpdateRate:

  If state updates per second exceed this threshold, the state will be displayed as CHANGING

• noisyStateUpdateRateValue:

  Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

• isStateUpdateNoisy:

  State update rate is above ‘Max State Update Rate’ threshold.

• reset:

  Resets the PLC hardware

• enableInterlockedSlots:

  Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

• disableInterlockedSlots:

  Send device into INTERLOCKED state, thus enabling all interlocked slots.

• requestHardwareValues:

  Ask for all property values on the device

• propertiesToPoll:

  All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

• pollInterval:

  Hardware poll interval in seconds

• propertiesToRead:

  The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

• readHardware:

  Requests value updates from the PLC for the properties listed under ‘Properties to read’

• force:

  ???

• trigger:

  Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.

• maxUpdateFrequency:

  set to limit maximum update frequency for some values.

• value:

  Analog input of ADC.

• semiRawValue:

  Semi raw value of analog input, i.e. the voltage.

• epsSemiRaw:

  Epsilon of the SemiRawValue.

• relativeEpsilon:

  Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History

4.8.2-2.11.1rc1

Created:2021-10-02T07:28:37.000+02:00 Author:Alessandro Silenzi Notes:Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.6.5-2.11.1

Created:2021-09-13T18:14:58.000+02:00 Author:xctrl Notes:

4.8.1-2.11.4

Created:2021-08-23T15:36:04.000+02:00 Author:Alessandro Silenzi Notes:Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created:2021-08-12T10:32:15.000+02:00 Author:Alessandro Silenzi Notes:Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created:2021-07-28T14:22:45.000+02:00 Author:Alessandro Silenzi Notes:

4.6.4-2.11.1-peltier-hotfix-@SPB

Created:2021-06-23T16:13:27.000+02:00 Author:xctrl Notes:

4.6.4-2.11.1

Created:

2021-06-22T13:56:55.000+02:00

Author:

Alessandro Silenzi

Notes:

• Fix for MC2 Elmo Feedback Configuration Options
• Optional sequential instantiation of Beckhoff devices for large loops
• Other optimizations

4.6.3-2.11.1

Created:2021-06-14T16:09:11.000+02:00 Author:Gabriele Giovanetti Notes:Added BeckhoffDryPump

4.6.2-2.11.0

Created:2021-06-10T11:55:43.000+02:00 Author:Alessandro Silenzi Notes:Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created:2021-06-07T19:31:48.000+02:00 Author:Valerii Bondar Notes:Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created:2021-06-02T14:39:34.000+02:00 Author:Gabriele Giovanetti Notes:

4.6.0-2.11.0

Created:

2021-06-02T14:39:34.000+02:00

Author:

Gabriele Giovanetti

Notes:

Summer shutdown release

Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass)

Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor

Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created:2021-05-31T09:49:13.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-04

Created:2021-04-26T14:46:29.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-03

Created:2021-04-23T08:19:59.000+02:00 Author:Gabriele Giovanetti Notes:

4.4.6-2.10.0-hotfix-02

Created:2021-04-23T07:43:58.000+02:00 Author:Steffen Hauf Notes:

4.4.6-2.10.0-hotfix-01

Created:2021-04-15T18:15:29.000+02:00 Author:Riccardo Fabbri Notes:

4.5.0-2.10.0

Created:2021-03-24T09:43:30.000+01:00 Author:Steffen Hauf Notes:Add the AIBS

4.4.6-2.10.0

Created:2021-03-08T09:52:30.000+01:00 Author:Riccardo Fabbri Notes:Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

TSYS

[add component documentation]

TIMESERVER

Instance id:LA1_LAS_PPL/TSYS/TIMESERVER Class id:TimeServer Host:la1-las-sys-utc-1 Class documentation:  TimeServer Alias:sa1-las-ppl-utca-1-cpu , la1-las-sys-utc-1-mch , la1-las-ppl-utca-1-cpu Git repo:https://git.xfel.eu/karaboDevices/timeServer Last modified:2021-09-14T08:39:06.351+02:00 Created at:2016-12-02T14:04:29.000+01:00 Main authors:Hauf, Haufs, Fabbri Latest tag:2.8.1-2.11.1 Deployment tag:2.8.1-2.11.1 Installed tag:2.8.1-2.11.1 Projects:LA1_DAQ_RUN_MGMT_NEW, LA1_DAQ_RUN_MGMT Scenes:Timing changes 800nm, test, trainID, Timing changes 800nm0, Timing changes 800nm_test0, old_Timing changes 800nm, Timing changes 800nm Accessible by:CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Time Server Documentation

The Time Server device is documented in timeServer:timeServer

Time Server Troubleshooting

To troubleshooting documentation

TrainId Workflow and Entities

To Train Id workflow documentation

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• tickFactor:

  The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”

• reset:

  Resets the device in case of an error

• id:

  Most recently published actual trigger ID

• periodActual:

  Most recently published actual period of the ID value increment

• idDiff:

  Difference of ID and its previously published value divided by tick factor

• source:

  Select source of trigger ID as an URI (‘local://internal’, ‘local://x2timer’, or ‘tcp://host:port’)

• devfile:

  Local device file to be used if “local://x2timer” was selected

• periodSet:

  Setpoint for the period of the ID value increment (used only for internally generated ID)

• minPeriod:

  Minimum period value to emit a signal.

• maxPeriod:

  Maximum period value to emit a signal.

• badTrainIdsCounter:

  Counter for non increasing trainId events. Maxes out at 100

• badPeriodsCounter:

  Number of times in a tick factor where the period has been set to 0

• badPeriods:

  Last periods out of bounds

• readBunchPatternTable:

  This flag enables the reading of bunch pattern table. To get the full bunch pattern tables with every train use the ‘Full Bunch Pattern Table Updates’ flag.

• bunchPatternTable:

  Is only output if both the ‘readBunchPatternTable’ and ‘fullBunchPatternUpdates’ flags are set.

• fullBunchPatternUpdates:

  If set to true the full bunch pattern table will be updated for each train and logged.

• outputBunchPattern:

  Output channel to which bunch pattern updates are sent. Bunch patterns are only output if the ‘readBunchPatternTable’ is set.

Release History

2.8.1-2.11.1

Created:2021-02-10T16:51:00.000+01:00 Author:Gabriele Giovanetti Notes:‘update-copied-headers’ into ‘master’

2.8.0-2.10.0

Created:2021-02-05T11:41:17.000+01:00 Author:Gero Flucke Notes:Fix bugs on period, C++14, fix CI

2.7.6-2.10.0

Created:2020-11-24T08:08:35.000+01:00 Author:Steffen Hauf Notes:

2.7.5-2.9.1

Created:2020-09-21T14:07:33.000+02:00 Author:Alessandro Silenzi Notes:Skip ticks with bad periods and added a bunch of instrumentation

2.7.4-2.9.1

Created:2020-08-17T11:38:17.000+02:00 Author:Riccardo Fabbri Notes:PatternTable array moved into data node of output channel for DAQ compatibility.

2.7.3-2.9.1

Created:2020-07-22T16:18:32.000+02:00 Author:Riccardo Fabbri Notes:Added slot for toggling data processing.

2.7.2-2.9.1

Created:2020-07-08T22:40:51.000+02:00 Author:Riccardo Fabbri Notes:PplBunchPatternStats: Node maxBufferLength is reconfigurable.

2.7.1-2.9.1

Created:2020-06-26T19:26:19.000+02:00 Author:Riccardo Fabbri Notes:Derive from BunchPattern digest a class with the metrics for PPL bits.

2.7.0-2.9.0

Created:2020-05-27T15:47:21.000+02:00 Author:Steffen Hauf Notes:

2.7.0-2.9

Created:2020-05-27T15:47:21.000+02:00 Author:Steffen Hauf Notes:Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created:2020-02-12T15:34:09.000+01:00 Author:Gero Flucke Notes:Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created:2019-05-07T16:35:38.000+02:00 Author:Alessandro Silenzi Notes:Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created:2019-01-23T10:01:43.000+01:00 Author:Alessandro Silenzi Notes:FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created:2018-12-10T14:26:22.000+01:00 Author:Alessandro Silenzi Notes:added DAQ Policy

2.5.0-2.2.6

Created:2018-11-29T16:54:33.000+01:00 Author:Alessandro Silenzi Notes:Added read Bunch Pattern table feature

2.4.0-2.1.15

Created:2018-02-27T11:18:55.000+01:00 Author:Gero Flucke Notes:Publish signalled trainIds to data logger

2.3.2-2.1.15

Created:2017-09-14T15:41:19.000+02:00 Author:Sergey Esenov Notes:Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created:2017-08-25T10:54:38.000+02:00 Author:Sergey Esenov Notes:Use timing from timing board with the following priority: ‘master’, ‘global’ or ‘board’ to avoid zero values.

2.3.0-2.1.15

Created:2017-08-20T14:55:53.000+02:00 Author:Sergey Esenov Notes:

2.2.0-2.1.12

Created:2017-06-12T15:43:27.000+02:00 Author:esenov Notes:

TIMESERVER_BSTATS_PPL

VACUUM

[add component documentation]

CONTROL

PPL Vacuum Control

The PplVacuumControl device is documented in pplVacuumControl:welcome

ADQ

[add component documentation]

1

Instance id:LA1_LAS_PPL/ADQ/1 Class id:AdqDigitizer Host:la1-las-sys-utc-1 Class documentation:  AdqDigitizer Alias:sa1-las-ppl-utca-1-cpu , la1-las-sys-utc-1-mch , la1-las-ppl-utca-1-cpu Git repo:https://git.xfel.eu/karaboDevices/adqDigitizer Last modified:2021-05-18T17:33:08.000+02:00 Created at:2017-05-09T17:54:27.000+02:00 Main authors:Hauf, Fabbri, Haufs Latest tag:4.4.4-2.10.0 Deployment tag:4.4.4-2.10.0 Installed tag:4.3.1-2.10.0 Scenes:TEST, test2, ADQ14 Accessible by:CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Might be hot-fixed, dt=5 days, 0:08:00!

Warning

The installed tag (4.3.1-2.10.0) does not match tags mentioned in the deployment ([‘4.4.4-2.10.0’])!

ADQ Digitizer

The AdqDigitizer device is documented in adqdigitizer:welcome

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• start:

  Starts data acquisition.

• stop:

  Stops data acquisition.

• swtrigger:

  Sends a software trigger to the hardware (always possible, independent of chosen trigger mode).

• reset:

  Resets the device by reconnecting the hardware.

• adqapiRevision:

  SP DEVICES software revision

• trainIdSource:

  Select source of train ID

• acquireCount:

  Number of triggers to process in one run (0 denotes an infinite run, which needs to be stopped explicitely).

• acquisitionTime:

  Acquisition time. Closely connected to ‘acquireCount’ (Triggers per Run): 1 sec == 10 triggers. 0 means forever. This parameter has a precedency over acquireCount.

• lengthOfBufferPool:

  Length of the pool of output Hashes for sending to DAQ. Run will be stopped if we use all entries.

• boardsTimeShift:

  The time shift between two consecutive boards in milliseconds while sending raw data from FPGA

• sizeFilledBuffers:

  Size of filled buffers queue. Normal to be 0. Max value is buffer pool size

• dumpEnable:

  If enabled the binary stream data will be stored without parsing as is

• dumpfile:

  File name of dumped RAW data for selected Board/Channel. Extension ‘.bin’ means binary otherwise text format

Release History

4.4.4-2.10.0

Created:2021-05-11T12:48:09.000+02:00 Author:Wajid Ehsan Notes:Avoid concurrent writes to the output channel

4.4.3-2.10.0

Created:2021-04-28T22:44:21.000+02:00 Author:Sergey Esenov Notes:Fix board configurations

4.4.2-2.10.0

Created:2021-04-12T17:06:38.000+02:00 Author:Wajid Ehsan Notes:Interim solution added to remind users that now cycling of DAQ is required to include schema related changes.

4.4.0-2.10.0

Created:2021-02-23T15:12:05.000+01:00 Author:Wajid Ehsan Notes:Tag for ADQ412. Firmware 021-002-006-A or 021-002-006-B required. For potential support for ADQ7 and ADQ14.

4.3.1-2.10.0

Created:2020-11-30T10:43:54.000+01:00 Author:Steffen Hauf Notes:

4.1.12-2.10.0

Created:2020-11-24T17:33:21.000+01:00 Author:Wajid Ehsan Notes:Tag to be used for old versions of the firmware which does not have the changing sample number issue

4.3.0-2.9.1-hotfix-2

Created:2020-09-07T14:05:12.000+02:00 Author:Robert Schaffer Notes:Added “None” option for trigger output

4.3.0-2.9.1-hotfix

Created:2020-08-31T09:05:31.000+02:00 Author:Robert Schaffer Notes:Removed zero suppression from the schema to eliminate issues with the DAQ

4.1.10-2.3.4-fix

Created:2020-08-12T16:10:52.000+02:00 Author:Robert Schaffer Notes:Similar fix for older digitizer firmware version

4.1.11-2.3.4-fix

Created:2020-08-12T14:35:04.000+02:00 Author:Robert Schaffer Notes:Tag to be used for old versions of the firmware which does not have the changing sample number issue

4.3.0-2.9.1

Created:2020-07-29T14:35:44.000+02:00 Author:Sergey Esenov Notes:Support for ADQ7, ADQ14 and fixed bug in ADQ412. Firmware 021-002-006-A required.

4.1.10-2.10.0-fix

Created:2020-07-29T14:35:44.000+02:00 Author:Sergey Esenov Notes:

4.2.1-2.8.0

Created:2020-05-07T16:14:35.000+02:00 Author:Sergey Esenov Notes:Updates and fixes to allow specific PES setup: high frequecy trigger rate, trigger signal on front panel,…

4.2.0-2.7.0

Created:2020-02-21T17:20:57.000+01:00 Author:Sergey Esenov Notes:Requires ADQ412-3G/4G firmware “021-002-006-A” and not backward compatible with older firmware versions. Experimental support for ADQ7. No support yet for ADQ14.

4.1.11-2.3.4

Created:2019-05-10T14:45:45.000+02:00 Author:Sergey Esenov Notes:This version requires the firmware ‘021-002-005-C’. Check the used firmware with AE group.

4.1.10-2.3.4

Created:2019-04-01T18:51:21.000+02:00 Author:Sergey Esenov Notes:Fix bug in initialization of NDArray in digitizer and use NDArrays by default.

4.1.9-2.3.4

Created:2019-03-21T11:30:39.000+01:00 Author:Sergey Esenov Notes:Fix calculation of number of pulses, improve error reporting and actions when stopping the run

4.1.8-2.3.4

Created:2019-03-05T16:54:26.000+01:00 Author:Sergey Esenov Notes:Bug fixing release: misinterpreted index, recovery trigger settings after the crash.

4.1.7-2.3.4

Created:2019-02-25T14:17:36.000+01:00 Author:Sergey Esenov Notes:Fix race condition and SEGFAULT.

4.1.6-2.3.4

Created:2019-02-19T16:09:13.000+01:00 Author:Sergey Esenov Notes:Attempt to fix SIGSEGV by avoid operations with invalid iterator. Introduce parameter that limits the time range where zero suppression and peak detection algorithms work.

POE

[add component documentation]

AC_SPB_DIAG

AC_XF2_DIAG

AMPHOS_BOOSTER

AMPHOS_FF

AMPHOS_INPUT_NF

AMPHOS_NF

FE_XF1_NF

FE_XF2_NF

FF_CAM_TEM

FXE_1030

FXE_DIAG

FXE_Instr_1

FXE_Instr_2

FXE_Instr_3

FXE_SEED

GALVO_FXE

GALVO_SPB

NOPA_FXE_1

NOPA_FXE_2

NOPA_FXE_3

NOPA_SPB_1

NOPA_SPB_2

NOPA_SPB_3

SPB_1030

SPB_Instr_1

SPB_Instr_2

SPB_Instr_3

SPB_SEED

FE_XF1_FF

AC_FXE_DIAG

DAQ

[add component documentation]

DATA

[add component documentation]

DM

[add component documentation]

RUN_CONTROL_1

Instance id:LA1_DAQ_DATA/DM/RUN_CONTROL_1 Class id:RunController Host:la1-br-sys-daq-srv1 Alias:la1-br-sys-daq-srv1 Git repo:https://git.xfel.eu/karaboDevices/pcLayer Last modified:2021-10-07T10:47:05.637+02:00 Created at:2017-01-12T16:45:11.000+01:00 Main authors:Al-qudami, Boukhelef Latest tag:1.11.0-2.11.4ra0 Deployment tag:1.11.0-2.11.4ra0 Projects:LA1_DAQ_RUN_MGMT, LA1_DAQ_RUN_MGMT_NEW Scenes:LA1_RUN_CONTROL_1-OBSOLETE, LA1_RUN_CONTROL_1, LA1_RUN_CONTROL_1, LA1_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, LA1_RUN_CONTROL_GLOBAL_STATE Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Controller:

  Main controller

• slotPushToDaq:

  Push run configuration to DAQ

• slotRetrieveProposalDetails:

  Retrieve proposal details

• actions:

  Actions

• version:

  Software version

• lastStatusMessage:

  Status message of last command

• alias:

  Device alias

• defaultMaxSize:

  Default max size for vectors when this is not specified in data schema

• runConfigurator:

  Run configurator

• dataManager:

  Data manager device

• metadataSchemaVersion:

  Metadata schema version

• proposalNumber:

  Proposal number

• proposalTitle:

  Proposal title

• proposalInstrument:

  Proposal instrument

• proposalDataPath:

  Proposal data path

• experiment:

  Experiment

• sample:

  Sample

• dataType:

  Data type

• runMsg:

  Run message

• runNumber:

  Run number

• runDetails:

  Run details

• trainId:

  Current Train Id(landmark)

• refTrainId:

  Method and offset for calculating the reference Train Id

• globalState:

  Global state details

• aggregators:

  Aggregators devices

• dataSourceToAggregatorsMapping:

  Data sources to aggregators mapping

• debug:

  Debug mode

• policy:

  Errors handling policy

• dataAggregatorsSpec:

  Data aggregators specification

• dataAggregators:

  Data aggregators

Release History

1.11.0-2.11.4ra0

Created:2021-09-28T14:01:16.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.5-2.11.4rc1

Created:2021-09-24T08:56:29.000+00:00 Author:Geogin Varghese Notes:pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created:2021-07-05T16:34:28.000+02:00 Author:Djelloul Boukhelef Notes:Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created:2021-06-28T09:58:03.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created:2021-06-25T08:12:26.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created:2021-06-24T01:21:52.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created:2021-06-21T01:03:13.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created:2021-06-14T07:48:22.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created:2021-06-09T23:44:24.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created:2021-06-09T16:22:33.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.3-2.10.5-ra1

Created:2021-06-09T14:53:52.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.1-2.10.1-rx2

Created:2021-06-03T18:06:16.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.1-2.10.1-rx1

Created:2021-06-02T12:39:31.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.2-2.10.0-rx4

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created:2021-05-26T08:29:43.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created:2021-05-25T18:06:03.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created:2021-05-14T10:36:11.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created:2021-05-06T17:43:49.000+02:00 Author:Alessandro Silenzi Notes:This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created:2021-04-30T02:26:16.000+02:00 Author:Djelloul Boukhelef Notes:

CONFIGURATOR_1

Instance id:LA1_DAQ_DATA/DM/CONFIGURATOR_1 Class id:RunConfigurator Host:la1-br-sys-daq-srv1 Alias:la1-br-sys-daq-srv1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Projects:LA1_DAQ_RUN_MGMT, LA1_DAQ_RUN_MGMT_NEW Scenes:LA1_RUN_CONTROL_1-OBSOLETE, LA1_RUN_CONTROL_1, LA1_RUN_CONTROL_1, LA1_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, LA1_RUN_CONTROL_GLOBAL_STATE Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• configurations:

  All configuration groups and their sources

• sources:

  Overall list of data sources and their attributes

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

DATA_MANAGER_1

Instance id:LA1_DAQ_DATA/DM/DATA_MANAGER_1 Class id:DataManager Host:la1-br-sys-daq-srv1 Alias:la1-br-sys-daq-srv1 Git repo:https://git.xfel.eu/karaboDevices/pcLayer Last modified:2021-10-07T10:47:05.637+02:00 Created at:2017-01-12T16:45:11.000+01:00 Main authors:Al-qudami, Boukhelef Latest tag:1.11.0-2.11.4ra0 Deployment tag:1.11.0-2.11.4ra0 Projects:LA1_DAQ_RUN_MGMT_NEW, LA1_DAQ_RUN_MGMT Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• reset:

  Resets the device in case of an error

• operationMode:

  Operation mode

• metadataSchemaVersion:

  Metadata schema version

• instrumentsList:

  List of instruments for this DAQ instance (e.g FXE,SA1)!

• proposalNumber:

  Proposal number

• experiment:

  Experiment

• sample:

  Sample

• dataType:

  Data type

• runNumber:

  Current run number

• user:

  User

• localConfiguration:

  Local configuration

• remoteConfiguration:

  Remote configuration

• debug:

  Debug mode

Release History

1.11.0-2.11.4ra0

Created:2021-09-28T14:01:16.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.5-2.11.4rc1

Created:2021-09-24T08:56:29.000+00:00 Author:Geogin Varghese Notes:pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created:2021-07-05T16:34:28.000+02:00 Author:Djelloul Boukhelef Notes:Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created:2021-06-28T09:58:03.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created:2021-06-25T08:12:26.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created:2021-06-24T01:21:52.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created:2021-06-21T01:03:13.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created:2021-06-14T07:48:22.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created:2021-06-09T23:44:24.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created:2021-06-09T16:22:33.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.3-2.10.5-ra1

Created:2021-06-09T14:53:52.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.1-2.10.1-rx2

Created:2021-06-03T18:06:16.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.1-2.10.1-rx1

Created:2021-06-02T12:39:31.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.2-2.10.0-rx4

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created:2021-05-26T08:29:43.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created:2021-05-25T18:06:03.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created:2021-05-14T10:36:11.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created:2021-05-06T17:43:49.000+02:00 Author:Alessandro Silenzi Notes:This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created:2021-04-30T02:26:16.000+02:00 Author:Djelloul Boukhelef Notes:

DSG_CHECK_1

Instance id:LA1_DAQ_DATA/DM/DSG_CHECK_1 Class id:CheckConfigGroups Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/karaboDevices/checkConfigGroups Last modified:2021-09-19T11:41:51.075+02:00 Created at:2018-03-13T18:16:19.000+01:00 Main authors:Maia, Haufs, Tirumalai Latest tag:2.2.2-2.5.0 Deployment tag:2.2.2-2.5.0 Projects:LA1_CHECK_CONFIG_GROUPS, LA1_DAQ_RUN_MGMT_NEW Scenes:EMAIL_COFIGURATION_GROUPS, CHECK_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS, CHECK_COFIGURATION_GROUPS Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• heartbeatInterval:

  The heartbeat interval

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• globalAlarmCondition:

  This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.

• visibility:

  Configures who is allowed to see this device at all

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server

• pid:

  The unix process ID of the device (i.e. of the server)

• state:

  The current state the device is in

• status:

  A more detailed status description

• lockedBy:

  The name of the device holding a lock on this one (empty if not locked)

• slotClearLock:

  Clear the lock on this device

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• log:

  Logging settings

• availableGroups:

  Avialable groups

• scanGroupsResult:

  Scan Results

• configuratorId:

  DAQ CONFIGURATOR device Id

• timeServerId:

  A timeServerId to get a trainId

• recentTrainId:

  Most recently published train ID from timeServer

• trainIdThreshold:

  Threshold for trainId

• checkTrainIdFrom:

  Return TrainId from device slot/configuration

Release History

2.2.2-2.5.0

Created:2021-07-08T18:01:02.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.1-2.5.0

Created:2021-06-28T21:45:57.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.0-2.5.0-test2

Created:2021-06-09T14:34:36.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.0-2.5.0

Created:2021-06-09T14:34:36.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.0-2.5.0-test

Created:2021-06-03T17:02:14.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.1.0-2.5.0

Created:2019-07-02T16:39:58.000+02:00 Author:Nasser Al-Qudami Notes:In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created:2019-04-17T17:54:16.000+02:00 Author:Luis Maia Notes:Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created:2019-04-01T10:08:53.000+02:00 Author:Nasser Al-Qudami Notes:Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created:2019-01-31T17:58:06.000+01:00 Author:Parthasarathy Tirumalai Notes:Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created:2019-01-31T12:36:28.000+01:00 Author:Nasser Al-Qudami Notes:This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created:2019-01-28T16:23:50.000+01:00 Author:Nasser Al-Qudami Notes:This tag includes bugs fix.

2.0.5-2.3.2

Created:

2019-01-25T10:40:18.000+01:00

Author:

Nasser Al-Qudami

Notes:

• Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created:2018-10-22T15:51:35.000+02:00 Author:Luis Maia Notes:Release tag 2.0.4

2.0.3-2.2.3

Created:2018-05-03T14:55:29.000+02:00 Author:Luis Maia Notes:Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created:2018-04-25T01:22:08.000+02:00 Author:Luis Maia Notes:Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created:2018-04-23T23:00:46.000+02:00 Author:Luis Maia Notes:Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created:2018-04-18T16:17:44.000+02:00 Author:Luis Maia Notes:Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created:2018-03-29T11:43:32.000+02:00 Author:Nasser Al-Qudami Notes:

1.1.3-2.2.2

Created:2018-03-29T11:36:38.000+02:00 Author:Nasser Al-Qudami Notes:

1.1.2-2.2.2

Created:2018-03-29T11:31:23.000+02:00 Author:Nasser Al-Qudami Notes:

DSG_REPORT_1

Instance id:LA1_DAQ_DATA/DM/DSG_REPORT_1 Class id:ReportConfigGroups Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/karaboDevices/checkConfigGroups Last modified:2021-09-19T11:41:51.075+02:00 Created at:2018-03-13T18:16:19.000+01:00 Main authors:Maia, Haufs, Tirumalai Latest tag:2.2.2-2.5.0 Deployment tag:2.2.2-2.5.0 Projects:LA1_CHECK_CONFIG_GROUPS, LA1_DAQ_RUN_MGMT_NEW Scenes:EMAIL_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• heartbeatInterval:

  The heartbeat interval

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• globalAlarmCondition:

  This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.

• visibility:

  Configures who is allowed to see this device at all

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server

• pid:

  The unix process ID of the device (i.e. of the server)

• state:

  The current state the device is in

• status:

  A more detailed status description

• lockedBy:

  The name of the device holding a lock on this one (empty if not locked)

• slotClearLock:

  Clear the lock on this device

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• log:

  Logging settings

• diffResult:

  Diff Results

• topicId:

  Topic identifier used by this device

• filenameId:

  Name of the file generated and send by email

• emailToId:

  Email to where the report should be send

Release History

2.2.2-2.5.0

Created:2021-07-08T18:01:02.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.1-2.5.0

Created:2021-06-28T21:45:57.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.0-2.5.0-test2

Created:2021-06-09T14:34:36.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.0-2.5.0

Created:2021-06-09T14:34:36.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.2.0-2.5.0-test

Created:2021-06-03T17:02:14.000+02:00 Author:Parthasarathy Tirumalai Notes:

2.1.0-2.5.0

Created:2019-07-02T16:39:58.000+02:00 Author:Nasser Al-Qudami Notes:In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created:2019-04-17T17:54:16.000+02:00 Author:Luis Maia Notes:Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created:2019-04-01T10:08:53.000+02:00 Author:Nasser Al-Qudami Notes:Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created:2019-01-31T17:58:06.000+01:00 Author:Parthasarathy Tirumalai Notes:Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created:2019-01-31T12:36:28.000+01:00 Author:Nasser Al-Qudami Notes:This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created:2019-01-28T16:23:50.000+01:00 Author:Nasser Al-Qudami Notes:This tag includes bugs fix.

2.0.5-2.3.2

Created:

2019-01-25T10:40:18.000+01:00

Author:

Nasser Al-Qudami

Notes:

• Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created:2018-10-22T15:51:35.000+02:00 Author:Luis Maia Notes:Release tag 2.0.4

2.0.3-2.2.3

Created:2018-05-03T14:55:29.000+02:00 Author:Luis Maia Notes:Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created:2018-04-25T01:22:08.000+02:00 Author:Luis Maia Notes:Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created:2018-04-23T23:00:46.000+02:00 Author:Luis Maia Notes:Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created:2018-04-18T16:17:44.000+02:00 Author:Luis Maia Notes:Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created:2018-03-29T11:43:32.000+02:00 Author:Nasser Al-Qudami Notes:

1.1.3-2.2.2

Created:2018-03-29T11:36:38.000+02:00 Author:Nasser Al-Qudami Notes:

1.1.2-2.2.2

Created:2018-03-29T11:31:23.000+02:00 Author:Nasser Al-Qudami Notes:

LA1_PLC_COMPSTAGE_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_PLC_COMPSTAGE_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LA1_PLC_ENV_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_PLC_ENV_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_20Hz_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_20Hz_GROUP Class id:RunConfigurationGroup Host:exflcon81n0 Alias:fxe-br-sys-daq-dsg1 , spb-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/gitlab/Karabo/Framework Last modified:2020-11-21T11:08:53.000+01:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Carinan, Danilevski, Mamchykd Latest tag:2.10.0rc6 Deployment tag:2.10.0rc6 Scenes:LA1_DAQ_DATA/DM/LAS_20Hz_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.10.0rc6

Created:2020-11-16T16:48:09.000Z Author:Cammille Carinan Notes:6-th Release Candidate for 2.10

2.10.0

Created:

2020-11-16T16:48:09.000Z

Author:

Cammille Carinan

Notes:

Karabo version 2.10.0

The most relevant improvements, fixes and changes are:

Core Functionality: A ConfigurationManager has been added to the framework, offering a new way to manage device configurations (Minimum Viable Product state)

GUI: - The Karabo GUI is shipped now with open license fonts to ensure

uniformity across the three supported platforms Linux, Windows and MacOS: Source Sans Pro, Source Serif Pro, Source Code Pro. All other fonts won’t be offered anymore.

• The configurator panel validates when configurations are retrieved from

  history, configuration DB or loaded from XML files.

• The layouts geometry are respecting the SVG backend

  This is an essential step to display Karabo Scenes in a Browser with the web interface. For this reason, we ask everyone to update their KaraboGUI client.

• Deprecations:

  • the grid layout won’t be offered anymore on grouping,
  • the DoubleWheelEdit controller has been deprecated,
  • the Slider widget has been deprecated.

Input-/OutputChannel Pipelines: - All APIs: The available options of the onSlowness parameter that

defines how an output channel should react if a connected input channel is not yet ready to receive more data, have changed: * The non-functional throw has been removed and a new option

queueDrop has been introduced (Minimum Viable Product state).

• The default has changed from wait to drop.

• MDL OutputChannel offers writeEndOfStream.

MDL: - Every requiredAccessLevel which will be at least AccessLevel.USER for

reconfigurable parameters if not explicitly specified.

• The event loop can be configured and set to uvLoop (https://github.com/MagicStack/uvloop)

C++ API - C++/bound: The legacy point-to-point shortcut for broker type communication has been removed.

(source of Data Logger inconsistencies for Karabo < 2.9)

See https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.10.html for more details.

2.10.0rc5

Created:2020-11-13T10:35:39.000Z Author:Dennis Goeries Notes:5th RC for 2.10.0

2.10.0rc4

Created:2020-11-11T18:10:00.000Z Author:Cammille Carinan Notes:4-th release candidate of 2.10.0

2.10.0rc3

Created:2020-11-10T16:48:35.000Z Author:Dennis Goeries Notes:3rd release candidate of 2.10

2.10.0rc2

Created:2020-11-06T16:41:13.000Z Author:Dennis Goeries Notes:2nd release candidate of 2.10

2.10.0rc1

Created:2020-11-04T17:01:01.000Z Author:Alessandro Silenzi Notes:First release candidate of 2.10.0

deps-rm-mqtt-downgradeboost

Created:2020-11-04T10:38:01.000Z Author:Cammille Carinan Notes:

2.10.0a26

Created:2020-10-30T15:10:56.000Z Author:Dennis Goeries Notes:

deps-upgrade-boostcpp14

Created:2020-10-28T14:50:56.000Z Author:Raul Costa Notes:

deps-upgrade-qwt

Created:2020-10-27T18:34:03.000Z Author:Raul Costa Notes:

deps-add-mqtt_cmake

Created:2020-10-27T18:34:03.000Z Author:Raul Costa Notes:

2.10.0a25

Created:2020-10-23T13:45:17.000Z Author:Dennis Goeries Notes:weekly release

2.10.0a24

Created:2020-10-16T23:58:16.000Z Author:Dennis Goeries Notes:

2.10.0a23

Created:2020-10-16T16:16:08.000Z Author:Cammille Carinan Notes:

2.10.0a22

Created:2020-10-09T13:52:57.000Z Author:Dennis Goeries Notes:

2.10.0a21

Created:2020-10-02T08:18:40.000Z Author:Dennis Goeries Notes:Weekly release

deps-add-centos8

Created:2020-09-29T19:41:22.000Z Author:Alessandro Silenzi Notes:Adding CentOS8 to the builds

2.10.0a20

Created:2020-09-29T06:13:38.000Z Author:Alessandro Silenzi Notes:Weekly release

deps-remove-snappy

Created:2020-09-28T15:38:31.000Z Author:Alessandro Silenzi Notes:

LAS_DIAG1_TEST_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Projects:LA1_CONFIG_GROUPS, LA1_DAQ_RUN_MGMT_NEW Scenes:LA1_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP|scene, LA1_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_DIAG_BECKHOFF_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_DIAG_BECKHOFF_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_DIAG_BECKHOFF_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_DIAG_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_DIAG_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_DIAG_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_FADC_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_FADC_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_FADC_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_FXE_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_FXE_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_FXE_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_PROC_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_PROC_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_PROC_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_SPB_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_SPB_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_SPB_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_SPECT_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_SPECT_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_SPECT_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LAS_TEMP_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_TEMP_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Scenes:LA1_DAQ_DATA/DM/LAS_TEMP_GROUP|scene Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

MDC_REMOTE_1

Instance id:LA1_DAQ_DATA/DM/MDC_REMOTE_1 Class id:MetadataDBRemote Host:la1-br-sys-daq-srv1 Alias:la1-br-sys-daq-srv1 Git repo:https://git.xfel.eu/karaboDevices/metadataDBRemote Last modified:2021-06-23T14:42:53.000+02:00 Created at:2017-03-02T16:11:47.000+01:00 Main authors:Maia, Hauf Latest tag:3.3.0-2.11.1 Deployment tag:3.3.0-2.11.1 Projects:LA1_DAQ_RUN_MGMT, LA1_DAQ_RUN_MGMT_NEW Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• client_email:

  Metadata Catalogue Client User email address

• client_id:

  Metadata Catalogue User Oauth identifier

• client_secret:

  Metadata Catalogue User Oauth secret

• metadata_application_url:

  Metadata Catalogue application Web Url

Release History

3.3.0-2.11.1

Created:2021-06-23T14:55:12.000+02:00 Author:Luis Maia Notes:Release tag 3.3.0-2.11.1

3.2.2-2.11.1

Created:2021-06-18T14:42:04.000+02:00 Author:Luis Maia Notes:Release tag 3.2.2-2.11.1

3.2.2-2.10.5

Created:2021-06-04T15:22:01.000+02:00 Author:Luis Maia Notes:Release tag 3.2.2-2.10.5

3.2.1-2.10.5.rc1

Created:2021-06-03T17:17:57.000+02:00 Author:Luis Maia Notes:Release tag 3.2.1-2.10.5.rc1

3.2.0-2.10.5

Created:2021-06-03T03:39:27.000+02:00 Author:Luis Maia Notes:Release tag 3.2.0-2.10.5

3.1.0-2.10.5

Created:2021-06-02T22:52:53.000+02:00 Author:Luis Maia Notes:Release tag 3.1.0-2.10.5

3.0.7-2.10.1-rx1

Created:2021-06-02T12:57:58.000+02:00 Author:Nasser Al-Qudami Notes:

3.0.7-2.9.2

Created:2020-06-30T22:51:41.000+02:00 Author:Luis Maia Notes:Release tag 3.0.7-2.9.2

3.0.6-2.9.1_rc1

Created:2020-06-11T10:48:57.000+02:00 Author:Luis Maia Notes:Release tag 3.0.6-2.9.1_rc1

3.0.4-2.9.1

Created:2020-01-27T12:14:04.000+01:00 Author:Luis Maia Notes:Release tag 3.0.4-2.9.1

3.0.4-2.7.0

Created:2020-01-27T12:14:04.000+01:00 Author:Luis Maia Notes:Release tag 3.0.4-2.7.0

3.0.3-2.6.1

Created:2019-08-23T08:12:16.000+02:00 Author:Luis Maia Notes:Release tag 3.0.3-2.6.1

3.0.3-2.5.1

Created:2019-08-23T00:53:46.000+02:00 Author:Luis Maia Notes:Release tag 3.0.3-2.5.1

3.0.0-2.5.1

Created:2019-08-16T15:26:20.000+02:00 Author:Luis Maia Notes:Release tag 3.0.0-2.5.1

2.0.0-2.2.0

Created:2017-12-21T15:52:41.000+01:00 Author:Luis Maia Notes:Release tag 2.0.0-2.2.0

1.1.6-2.1.18

Created:2017-12-21T09:32:55.000+01:00 Author:Luis Maia Notes:Release tag 1.1.6-2.1.18

1.1.5-2.1.18

Created:2017-12-20T11:48:53.000+01:00 Author:Luis Maia Notes:In this tag: * Release version 1.1.5-2.1.18 * Update MetadataClient to 1.1.4.1 * Comment issue that prevents device installation via Ansible

1.1.4-2.1.16

Created:2017-11-10T14:19:21.000+01:00 Author:Luis Maia Notes:Release tag 1.1.4-2.1.16

1.1.2-2.1.12

Created:2017-09-13T20:17:46.000+02:00 Author:Luis Maia Notes:Release tag 1.1.2-2.1.12

1.1.1-2.1.12

Created:2017-09-04T18:42:01.000+02:00 Author:Luis Maia Notes:Release tag 1.1.1-2.1.12

LAS_20HZ_GROUP

Instance id:LA1_DAQ_DATA/DM/LAS_20HZ_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LA1_AMPHOS_CAM_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_AMPHOS_CAM_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LA1_DOC_ADHOC_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_DOC_ADHOC_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LA1_FRONTEND_CAM_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_FRONTEND_CAM_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LA1_FXE_CAM_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_FXE_CAM_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

LA1_SPB_CAM_GROUP

Instance id:LA1_DAQ_DATA/DM/LA1_SPB_CAM_GROUP Class id:RunConfigurationGroup Host:la1-br-sys-daq-dsg1 Alias:la1-br-sys-daq-dsg1 Git repo:https://git.xfel.eu/Karabo/Framework Last modified:2021-10-07T16:45:42.947+02:00 Created at:2016-02-25T15:17:38.000+01:00 Main authors:Goeries, Costa Latest tag:2.12.0rc2 Deployment tag:2.12.0rc2 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• timeServerId:

  The instance id uniquely identifies a TimeServer instance in the distributed system

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• Logger:

  Logging settings

• group:

  Structure describing data sources logically belonging together.

• owner:

  The person to contact regarding usage of this group

Release History

2.12.0rc2

Created:2021-09-29T14:00:53.000+02:00 Author:Alessandro Silenzi Notes:2nd release candidate of 2.12.0

2.12.0

Created:

2021-09-29T14:00:53.000+02:00

Author:

Alessandro Silenzi

Notes:

Release of the Karabo Framework 2.12.

It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created:2021-09-27T15:58:05.000+02:00 Author:Gero Flucke Notes:1st release candidate of 2.12.0

2.12.0a10

Created:2021-09-15T14:44:02.000+02:00 Author:Dennis Goeries Notes:

deps-update-redisclient102dev

Created:2021-09-15T08:51:47.000+02:00 Author:Raul Costa Notes:Update the redis client

2.12.0a9

Created:2021-08-24T11:16:33.000+02:00 Author:Gero Flucke Notes:

2.12.0a8

Created:2021-08-23T11:54:12.000+02:00 Author:Gero Flucke Notes:

2.12.0a7

Created:2021-08-13T18:29:03.000+02:00 Author:Alessandro Silenzi Notes:

2.12.0a6

Created:2021-08-13T11:40:40.000+02:00 Author:Gero Flucke Notes:

deps-add-amqp

Created:2021-08-06T15:19:37.000+02:00 Author:Sergey Esenov Notes:

2.11.4rc1

Created:2021-07-21T17:31:29.000+02:00 Author:Alessandro Silenzi Notes:First rc of 2.11.4

2.11.4

Created:

2021-07-21T17:31:29.000+02:00

Author:

Alessandro Silenzi

Notes:

FIX: Drop early data on InfluxDb

GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created:2021-07-09T12:42:52.000+02:00 Author:Dennis Goeries Notes:

2.12.0a5

Created:2021-07-09T12:13:14.000+02:00 Author:Sergey Esenov Notes:

deps-add-multiBrokerDeps

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:

2.12.0a4

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Same as 2.12.0a3

2.12.0a3

Created:2021-07-07T13:49:07.000+02:00 Author:Gero Flucke Notes:Experimental branch with many brokers

2.11.2

Created:2021-06-29T14:30:20.000+02:00 Author:Gero Flucke Notes:

2.11.2rc4

Created:2021-06-23T17:14:20.000+02:00 Author:Dennis Goeries Notes:

2.11.2rc3

Created:2021-06-22T19:53:47.000+02:00 Author:Dennis Goeries Notes:

DA

[add component documentation]

2

Instance id:LA1_DAQ_DATA/DA/2 Class id:DataAggregator Host:la1-br-sys-daq-srv1 Alias:la1-br-sys-daq-srv1 Git repo:https://git.xfel.eu/karaboDevices/pcLayer Last modified:2021-10-07T10:47:05.637+02:00 Created at:2017-01-12T16:45:11.000+01:00 Main authors:Al-qudami, Boukhelef Latest tag:1.11.0-2.11.4ra0 Deployment tag:1.11.0-2.11.4ra0 Projects:LA1_DAQ, LA1_DAQ_RUN_MGMT, LA1_DAQ, LA1_DAQ_RUN_MGMT_NEW Scenes:LA1_RUN_CONTROL_1-OBSOLETE, Run Control Status, Run Control Status, LA1_RUN_CONTROL_1, Run Control Status, LA1_RUN_CONTROL_1, LA1_RUN_CONTROL_1 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• reset:

  Reset

• version:

  Software version

• lastStatusMessage:

  Status message of last command

• loggerConfig:

  Runtime logger configuration

• policy:

  Errors handling policy

• ApplicationMonitor:

  Application health monitor

• BookKeeper:

  Book keeper

• BufferManager:

  Buffer manager

• DataAccessor0:

  Data accessor 0

• DataAccessor1:

  Data accessor 1

• DataDispatcher:

  Data dispatcher

• DataIntegrator:

  Data integrator

• DataMonitor:

  Data content monitor

• FastDataCollector:

  Fast data collector

• Formatter:

  Formatter

• InternalTrigger:

  Internal trigger

• MessageLogger:

  Message logger

• PreProcessor:

  Pre processor

• Scheduler:

  Scheduler

• SlowDataCollector:

  Slow data collector

• StatisticsBuilder:

  Statistics builder

• Summarizer:

  Data summarizer

• TrainDataReceiver:

  Train data receiver

• TrainReconstructor:

  Train data reconstructor

• Vectorizer:

  Data vectorizer

• Writer:

  Writer

• enableDaqNode:

  Enable DAQ node

• storageManager:

  Storage manager device

• alias:

  Device alias

• groupId:

  Aggregators group Id

• groupInfix:

  Aggregators group infix

• channelId:

  channel Id

• channelsCount:

  Number of channels

• mountPoint:

  Mount point

• dataPath:

  Proposal data path

• chunkSize:

  Number of trains to buffer in memory

• chunksCount:

  Chunk count per file

• maxExpectedPulses:

  Maximum number of pulses expected per train

• dataType:

  Data type

• runController:

  Run controller

• experimentDetails:

  Experiment details

• sampleDetails:

  Sample details

• runDetails:

  Run details

• enableXTDF:

  Enable receiving train data via UDP

• OriginalDataFormat:

  Name of file that contains the original data format description, include train data format, dataset and run info.

• Detector:

  Name of file that contains the detector configuration.

• metrics:

  Heath and performance metrics

Release History

1.11.0-2.11.4ra0

Created:2021-09-28T14:01:16.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.5-2.11.4rc1

Created:2021-09-24T08:56:29.000+00:00 Author:Geogin Varghese Notes:pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created:2021-07-05T16:34:28.000+02:00 Author:Djelloul Boukhelef Notes:Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created:2021-06-28T09:58:03.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created:2021-06-25T08:12:26.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created:2021-06-24T01:21:52.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created:2021-06-21T01:03:13.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created:2021-06-14T07:48:22.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created:2021-06-09T23:44:24.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created:2021-06-09T16:22:33.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.3-2.10.5-ra1

Created:2021-06-09T14:53:52.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.1-2.10.1-rx2

Created:2021-06-03T18:06:16.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.1-2.10.1-rx1

Created:2021-06-02T12:39:31.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.2-2.10.0-rx4

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created:2021-05-26T08:29:43.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created:2021-05-25T18:06:03.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created:2021-05-14T10:36:11.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created:2021-05-06T17:43:49.000+02:00 Author:Alessandro Silenzi Notes:This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created:2021-04-30T02:26:16.000+02:00 Author:Djelloul Boukhelef Notes:

DOC

[add component documentation]

1

Instance id:LA1_DAQ_DATA/DOC/1 Class id:DataAggregator Host:la1-br-sys-daq-srv1 Alias:la1-br-sys-daq-srv1 Git repo:https://git.xfel.eu/karaboDevices/pcLayer Last modified:2021-10-07T10:47:05.637+02:00 Created at:2017-01-12T16:45:11.000+01:00 Main authors:Al-qudami, Boukhelef Latest tag:1.11.0-2.11.4ra0 Deployment tag:1.11.0-2.11.4ra0 Accessible by:

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

• visibility:

  Configures who is allowed to see this device at all

• deviceId:

  The device instance ID uniquely identifies a device instance in the distributed system

• classId:

  The (factory)-name of the class of this device

• classVersion:

  The version of the class of this device defined in KARABO_CLASSINFO

• karaboVersion:

  The version of the Karabo framework running this device

• serverId:

  The device-server on which this device is running on

• hostName:

  Do not set this property, it will be set by the device-server.

• pid:

  The unix process ID of the device (i.e. of the server

• state:

  The current state the device is in

• status:

  A more detailed status description

• alarmCondition:

  The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.

• lastCommand:

  The last slot called.

• archive:

  Decides whether the properties of this device will be logged or not

• useTimeserver:

  Unused - whether device connects to time server is configured via ‘timeServerId’

• progress:

  The progress of the current action

• heartbeatInterval:

  The heartbeat interval

• performanceStatistics:

  Accumulates some statistics

• reset:

  Reset

• version:

  Software version

• lastStatusMessage:

  Status message of last command

• loggerConfig:

  Runtime logger configuration

• policy:

  Errors handling policy

• ApplicationMonitor:

  Application health monitor

• BookKeeper:

  Book keeper

• BufferManager:

  Buffer manager

• DataAccessor0:

  Data accessor 0

• DataAccessor1:

  Data accessor 1

• DataDispatcher:

  Data dispatcher

• DataIntegrator:

  Data integrator

• DataMonitor:

  Data content monitor

• FastDataCollector:

  Fast data collector

• Formatter:

  Formatter

• InternalTrigger:

  Internal trigger

• MessageLogger:

  Message logger

• PreProcessor:

  Pre processor

• Scheduler:

  Scheduler

• SlowDataCollector:

  Slow data collector

• StatisticsBuilder:

  Statistics builder

• Summarizer:

  Data summarizer

• TrainDataReceiver:

  Train data receiver

• TrainReconstructor:

  Train data reconstructor

• Vectorizer:

  Data vectorizer

• Writer:

  Writer

• enableDaqNode:

  Enable DAQ node

• storageManager:

  Storage manager device

• alias:

  Device alias

• groupId:

  Aggregators group Id

• groupInfix:

  Aggregators group infix

• channelId:

  channel Id

• channelsCount:

  Number of channels

• mountPoint:

  Mount point

• dataPath:

  Proposal data path

• chunkSize:

  Number of trains to buffer in memory

• chunksCount:

  Chunk count per file

• maxExpectedPulses:

  Maximum number of pulses expected per train

• dataType:

  Data type

• runController:

  Run controller

• experimentDetails:

  Experiment details

• sampleDetails:

  Sample details

• runDetails:

  Run details

• enableXTDF:

  Enable receiving train data via UDP

• OriginalDataFormat:

  Name of file that contains the original data format description, include train data format, dataset and run info.

• Detector:

  Name of file that contains the detector configuration.

• metrics:

  Heath and performance metrics

Release History

1.11.0-2.11.4ra0

Created:2021-09-28T14:01:16.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.5-2.11.4rc1

Created:2021-09-24T08:56:29.000+00:00 Author:Geogin Varghese Notes:pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created:2021-07-05T16:34:28.000+02:00 Author:Djelloul Boukhelef Notes:Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created:2021-06-28T09:58:03.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created:2021-06-25T08:12:26.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created:2021-06-24T01:21:52.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created:2021-06-21T01:03:13.000+02:00 Author:Djelloul Boukhelef Notes:Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created:2021-06-14T07:48:22.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created:2021-06-09T23:44:24.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created:2021-06-09T16:22:33.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.3-2.10.5-ra1

Created:2021-06-09T14:53:52.000+02:00 Author:Djelloul Boukhelef Notes:

1.10.1-2.10.1-rx2

Created:2021-06-03T18:06:16.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.1-2.10.1-rx1

Created:2021-06-02T12:39:31.000+02:00 Author:Nasser Al-Qudami Notes:

1.10.2-2.10.0-rx4

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created:2021-05-26T14:25:23.000+02:00 Author:Djelloul Boukhelef Notes:Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created:2021-05-26T08:29:43.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created:2021-05-25T18:06:03.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created:2021-05-14T10:36:11.000+02:00 Author:Djelloul Boukhelef Notes:Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created:2021-05-06T17:43:49.000+02:00 Author:Alessandro Silenzi Notes:This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created:2021-04-30T02:26:16.000+02:00 Author:Djelloul Boukhelef Notes:

CTRL

[add component documentation]

TOOLING

[add component documentation]

MDL

[add component documentation]

BECKHOFF_ASSISTANT

VERIFY

[add component documentation]

MDL

[add component documentation]

ARCHIVE

Non-standard installations

Host could not be accessed

Affected classes:  DataAggregator, RunConfigurator, DataManager, MetadataDBRemote, RunController Affected devices:  LA1_DAQ_DATA/DA/1, LA1_DAQ_DATA/DA/2, LA1_DAQ_DATA/DOC/1, LA1_DAQ_DATA/DM/CONFIGURATOR_1, LA1_DAQ_DATA/DM/DATA_MANAGER_1, LA1_DAQ_DATA/DM/MDC_REMOTE_1, LA1_DAQ_DATA/DM/RUN_CONTROL_1

Host could not be accessed

Affected classes:  

CheckConfigGroups, ReportConfigGroups, RunConfigurationGroup

Affected devices:  

LA1_DAQ_DATA/DM/DSG_CHECK_1, LA1_DAQ_DATA/DM/DSG_REPORT_1, LA1_DAQ_DATA/DM/LA1_AMPHOS_CAM_GROUP, LA1_DAQ_DATA/DM/LA1_DOC_ADHOC_GROUP, LA1_DAQ_DATA/DM/LA1_FRONTEND_CAM_GROUP, LA1_DAQ_DATA/DM/LA1_FXE_CAM_GROUP, LA1_DAQ_DATA/DM/LA1_PLC_COMPSTAGE_GROUP, LA1_DAQ_DATA/DM/LA1_PLC_ENV_GROUP, LA1_DAQ_DATA/DM/LA1_SPB_CAM_GROUP, LA1_DAQ_DATA/DM/LAS_20HZ_GROUP, LA1_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP, LA1_DAQ_DATA/DM/LAS_DIAG_BECKHOFF_GROUP, LA1_DAQ_DATA/DM/LAS_DIAG_GROUP, LA1_DAQ_DATA/DM/LAS_FADC_GROUP, LA1_DAQ_DATA/DM/LAS_FXE_GROUP, LA1_DAQ_DATA/DM/LAS_PROC_GROUP, LA1_DAQ_DATA/DM/LAS_SPB_GROUP, LA1_DAQ_DATA/DM/LAS_SPECT_GROUP, LA1_DAQ_DATA/DM/LAS_TEMP_GROUP

BeckhoffAnalogOutput:  

• affected devices: LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH1, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH2, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH3, LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH4, LA1_LAS_PPL/ACTRL/GUIDELASER_FXE_MOD_IN, LA1_LAS_PPL/ACTRL/GUIDELASER_SPB_MOD_IN
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffAnalogInput:  

• affected devices: LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH1, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH2, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH3, LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH4, LA1_LAS_PPL/ASENS/GUIDELASER_FXE_CTL_OUT, LA1_LAS_PPL/ASENS/GUIDELASER_SPB_CTL_OUT, LA1_LAS_PPL/ASENS/HUMIDITY, LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_FXE, LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_SPB, LA1_LAS_PPL/TSENS/TEMPERATURE, LA1_LAS_PPL/TSENS/TEMP_EQUIP_1, LA1_LAS_PPL/TSENS/TEMP_EQUIP_2, LA1_LAS_PPL/TSENS/TEMP_EQUIP_3, LA1_LAS_PPL/TSENS/TEMP_EQUIP_4, LA1_LAS_PPL/TSENS/TEMP_EQUIP_5, LA1_LAS_PPL/TSENS/TEMP_EQUIP_6, LA1_LAS_PPL/TSENS/TEMP_EQUIP_7, LA1_LAS_PPL/TSENS/TEMP_EQUIP_8, LA1_LAS_PPL/TSENS/TEMP_TABLE_1, LA1_LAS_PPL/TSENS/TEMP_TABLE_2, LA1_LAS_PPL/TSENS/TEMP_TABLE_3, LA1_LAS_PPL/TSENS/TEMP_TABLE_4, LA1_LAS_PPL/TSENS/TEMP_TABLE_5, LA1_LAS_PPL/TSENS/TEMP_TABLE_6, LA1_LAS_PPL/TSENS/TEMP_TABLE_7, LA1_LAS_PPL/TSENS/TEMP_TABLE_8
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffDigitalOutput:  

• affected devices: LA1_LAS_PPL/DCTRL/CMCOMPSTAGE, LA1_LAS_PPL/DCTRL/DMCOMPSTAGE, LA1_LAS_PPL/DCTRL/GUIDELASER_FXE_LD_REM, LA1_LAS_PPL/DCTRL/GUIDELASER_SPB_LD_REM, LA1_LAS_PPL/DCTRL/LAB_CHILLER_REMOTE_START, LA1_LAS_PPL/DCTRL/NANOSSPARE1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_2, LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_1, LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_2, LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_ON_OFF
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffEncoder:  

• affected devices: LA1_LAS_PPL/ENC/CMCOMPSTAGE, LA1_LAS_PPL/ENC/DMCOMPSTAGE, LA1_LAS_PPL/ENC/NANOSSPARE1, LA1_LAS_PPL/ENC/TRACEYCOMP_FXE_1, LA1_LAS_PPL/ENC/TRACEYCOMP_FXE_2, LA1_LAS_PPL/ENC/TRACEYCOMP_SPB_1, LA1_LAS_PPL/ENC/TRACEYCOMP_SPB_2
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffMonitor:  

• affected devices: LA1_LAS_PPL/MDL/BECKHOFF_MONITOR
• installed at: None
• installation not in a standard path

BeckhoffSimpleMotor:  

• affected devices: LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA, LA1_LAS_PPL/MOTOR/CYLLENS_FXE_SA, LA1_LAS_PPL/MOTOR/CYLLENS_SPB_FA, LA1_LAS_PPL/MOTOR/CYLLENS_SPB_SA, LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_3, LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_4, LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_FXE, LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPB, LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_FXE, LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPB, LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_FXE, LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPB, LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_FXE, LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPB, LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_FXE, LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPB, LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_FXE, LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SPB, LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_FXE, LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPB, LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_FXE, LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPB, LA1_LAS_PPL/MOTOR/ROT_SPARE_3, LA1_LAS_PPL/MOTOR/ROT_SPARE_4, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE, LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB, LA1_LAS_PPL/MOTOR/WP_DIAG_FXE, LA1_LAS_PPL/MOTOR/WP_DIAG_SPB, LA1_LAS_PPL/MOTOR/WP_FXE_1, LA1_LAS_PPL/MOTOR/WP_FXE_2, LA1_LAS_PPL/MOTOR/WP_FXE_CR_1, LA1_LAS_PPL/MOTOR/WP_FXE_CR_2, LA1_LAS_PPL/MOTOR/WP_FXE_CR_3, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_1, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_2, LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_3, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_1, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_2, LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_3, LA1_LAS_PPL/MOTOR/WP_SPB_1, LA1_LAS_PPL/MOTOR/WP_SPB_2, LA1_LAS_PPL/MOTOR/WP_SPB_CR_1, LA1_LAS_PPL/MOTOR/WP_SPB_CR_2, LA1_LAS_PPL/MOTOR/WP_SPB_CR_3, LA1_LAS_PPL/MOTOR/WP_TEM, LA1_LAS_PPL/PMOTOR/CMCOMPSTAGE, LA1_LAS_PPL/PMOTOR/DMCOMPSTAGE, LA1_LAS_PPL/PMOTOR/NANOSSPARE1, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_1, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_2, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_1, LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_2
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffCom:

• affected devices: LA1_LAS_PPL/PLC/COM
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffPlcMonitor:  

• affected devices: LA1_LAS_PPL/PLC/COM_PLCMON
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffDigitalInput:  

• affected devices: LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_STATUS, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_COLLECTIVE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_FLOW_1, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_GUIDE_VALUE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_PRESSURE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_TEMPERATURE, LA1_LAS_PPL/SWITCH/LABCHL_ALARM_WATERLEVEL
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

BeckhoffValve:

• affected devices: LA1_LAS_PPL/VALVE/VALVE_FXE, LA1_LAS_PPL/VALVE/VALVE_SPARE1, LA1_LAS_PPL/VALVE/VALVE_SPARE2, LA1_LAS_PPL/VALVE/VALVE_SPB
• installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so
• not the deployed tag: 4.6.4-2.11.1 not in [‘4.8.2-2.11.1rc1’]

FastAdc:

• affected devices: SPB_RR_SYS/ADC/UTC1-2
• installed at: None
• installation not in a standard path

AdqDigitizer:

• affected devices: LA1_LAS_PPL/ADQ/1
• installed at: /home/xctrl/karabo/plugins/libadqDigitizer.so
• might be hot-fixed, dt=5 days, 0:08:00
• not the deployed tag: 4.3.1-2.10.0 not in [‘4.4.4-2.10.0’]

PplMultiSubPattern:  

• affected devices: LA1_LAS_PPL/MDL/MULTI_PATTERN
• installed at: /scratch/xctrl/karabo/extern/lib/python3.6/site-packages/PplPattern.egg-link
• is a development install
• might be hot-fixed, dt=56 days, 14:58:00
• not the deployed tag: 1.5.6-2.10.0 not in [‘1.6.0-2.11.0’]

Non-standard deployments

la1-rr-ppl-con-1

• Rogue install for BeckhoffAnalogOutput: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffAnalogInput: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffDigitalOutput: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffEncoder: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffMonitor: 1.1.6-2.10.0 installed but not in deployment.
• Rogue install for BeckhoffSimpleMotor: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffCom: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffPlcMonitor: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffDigitalInput: 4.6.4-2.11.1 installed but not in deployment.
• Rogue install for BeckhoffValve: 4.6.4-2.11.1 installed but not in deployment.

la1-las-sys-utc-1

• Rogue install for FastAdc: 2.8.6-2.11.1 installed but not in deployment.
• Rogue install for AdqDigitizer: 4.3.1-2.10.0 installed but not in deployment.
• Rogue install for TimeServer: 2.8.1-2.11.1 installed but not in deployment.

exflcon146

• Rogue install for PplMultiSubPattern: 1.5.6-2.10.0 installed but not in deployment.

Non-standard instance ids

• KaraboGuiErrorLogger
• tmp_server

Problematic Interface Configs

Non-reachable devices

These devices are not included in any project or scene

• LA1_DAQ_DATA/DM/LA1_AMPHOS_CAM_GROUP
• LA1_DAQ_DATA/DM/LA1_DOC_ADHOC_GROUP
• LA1_DAQ_DATA/DM/LA1_FRONTEND_CAM_GROUP
• LA1_DAQ_DATA/DM/LA1_FXE_CAM_GROUP
• LA1_DAQ_DATA/DM/LA1_PLC_COMPSTAGE_GROUP
• LA1_DAQ_DATA/DM/LA1_PLC_ENV_GROUP
• LA1_DAQ_DATA/DM/LA1_SPB_CAM_GROUP
• LA1_DAQ_DATA/DM/LAS_20HZ_GROUP
• LA1_DAQ_DATA/DOC/1
• LA1_LAS_PPL/PLC/COM_PLCMON
• tmp_server

Access Rights Summary

CAL:la1-rr-ppl-con-1, exflcon146 CONTROLS:la1-rr-ppl-con-1, la1-las-sys-utc-1, exflcon146 CTRL:la1-rr-ppl-con-1, la1-las-sys-utc-1, exflcon146 DA:la1-rr-ppl-con-1, exflcon146 WP78:la1-rr-ppl-con-1 brambrin:la1-rr-ppl-con-1 danilevc:la1-rr-ppl-con-1, exflcon146 kaned:la1-rr-ppl-con-1, la1-las-sys-utc-1 pallasf:la1-rr-ppl-con-1 xdoc:la1-rr-ppl-con-1, la1-las-sys-utc-1, exflcon146 babies:la1-las-sys-utc-1 cascella:la1-las-sys-utc-1 mramilli:la1-las-sys-utc-1 samartse:la1-las-sys-utc-1 tjezynsk:la1-las-sys-utc-1, exflcon146

Scenes with outdated properties

The following scenes my contain properties not available anymore, or only available as part of a macro, which is not guaranteed to alway run.

Scenes

All in 1

projects:Temperature and Humidity

• LA1_LAS_PPL/TSENS/TEMP_TABLE_1.value,LA1_LAS_PPL/TSENS/TEMP_TABLE_2.value,LA1_LAS_PPL/TSENS/TEMP_TABLE_3.value,LA1_LAS_PPL/TSENS/TEMP_TABLE_4.value,LA1_LAS_PPL/TSENS/TEMP_TABLE_5.value,LA1_LAS_PPL/TSENS/TEMPERATURE.value,LA1_LAS_PPL/TSENS/TEMP_TABLE_7.value

LA1_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern

projects:LA1_PPL_PATTERN

• LA1_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.bunchOffset
• LA1_LAS_PPL/MDL/MULTI_PATTERN.applyUserConfigToDoocs
• PPL_MULTI_SUBPATTERN.status
• LA1_LAS_PPL/MDL/MULTI_PATTERN.xfelBunchCharge,LA1_LAS_PPL/MDL/MULTI_PATTERN.doocsPplPattern,LA1_LAS_PPL/MDL/MULTI_PATTERN.userPplPattern
• LA1_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.bunchOffset
• PPL_MULTI_SUBPATTERN.totBurstDuration
• LA1_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.bunchOffset
• LA1_LAS_PPL/MDL/MULTI_PATTERN.patternRepFactor
• LA1_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.bunchOffset

LA1_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern

projects:LA1_PPL_PATTERN

• LA1_LAS_PPL/MDL/MULTI_PATTERN.patternRepFactor
• LA1_LAS_PPL/MDL/MULTI_PATTERN.xfelBunchCharge,LA1_LAS_PPL/MDL/MULTI_PATTERN.doocsPplPattern,LA1_LAS_PPL/MDL/MULTI_PATTERN.userPplPattern
• LA1_LAS_PPL/MDL/MULTI_PATTERN.applyUserConfigToDoocs

PPL_HISTORY

projects:LA1_DIAG

• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.state
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.pplHistory
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.startDate
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.execute
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.interval
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.stopDate
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.status
• Macro-GetPplHistory-67e0c380-2e4a-40de-842d-e568e5ec2ac6-GetPplHistory.instrument

FXE status scene

projects:Instrument Timing and Status

• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.alive
• LA1_LAS_PPL/PROC/NOPA_FXE_2.x0,LA1_LAS_PPL/PROC/NOPA_FXE_2.y0
• LA1_LAS_PPL/PROC/NOPA_FXE_2.x01d,LA1_LAS_PPL/PROC/NOPA_FXE_2.y01d
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_FXEp
• LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum

Shift change

projects:LA1_LAS_TIMING

• LA1_LAS_PPL/CTRL/TRGDLY.triggerFE_FXE
• LA1_LAS_PPL/CTRL/TRGDLY.triggerFE_SPB
• LA1_LAS_PPL/CTRL/TRGDLY.isPockelsCellOn

TMP

projects:LA1_GALVO

• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pedestalEntries
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.noise
• LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum,LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths
• Macro-macro_sample-23b87eda-6038-41f0-99b8-51a5ecc48043-AdcRawDataPlot.vvv2
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.adcChannel
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.maxDeviation
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.adcDevice
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pedestal
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.thresholdFactor
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.state
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.updateInterval
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.status
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pulseDelayDev
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.initialDelay
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.isPositionOk
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.peakPos
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.deviceId
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.peakPos,LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pulseDelayDev
• LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum

FXE-1st-stage_test

projects:LA1_FXE_NOPA

• LA1_LAS_PPL/SPECT/NOPA_FXE_2X.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_2X.output.schema.data.spectrum
• LA1_LAS_PPL/PROC/NOPA_FXE_1.x01d,LA1_LAS_PPL/PROC/NOPA_FXE_1.y01d

SPB-1030-Status-Scene

projects:Instrument Timing and Status

• LA1_LAS_PPL/PROC/SPB_UNCOMP.x01d,LA1_LAS_PPL/PROC/SPB_UNCOMP.y01d
• LA1_LAS_PPL/PROC/SPB_UNCOMP.beamHeight1d,LA1_LAS_PPL/PROC/SPB_UNCOMP.beamWidth1d

LA1_LAS_PPLMOTORWP_FXE_CR_1

projects:LA1_FXE_NOPA

• LA1_LAS_PPL/MOTOR/WP_FXE_CR_1.vMaxUnit

LA1_LAS_PPLMOTORWP_FXE_CR_2

projects:LA1_FXE_NOPA

• LA1_LAS_PPL/MOTOR/WP_FXE_CR_2.isHardwareLimitHigh
• LA1_LAS_PPL/MOTOR/WP_FXE_CR_2.encoderPosition
• LA1_LAS_PPL/MOTOR/WP_FXE_CR_2.vMaxUnit
• LA1_LAS_PPL/MOTOR/WP_FXE_CR_2.isSoftwareLimitHigh
• LA1_LAS_PPL/MOTOR/WP_FXE_CR_2.isHardwareLimitLow
• LA1_LAS_PPL/MOTOR/WP_FXE_CR_2.isSoftwareLimitLow

Chiller

projects:LA1_CHILLER

• LA1_LAS_PPL/SWITCH/CHILLER.connectedDevices.pressureAlarmNode
• LA1_LAS_PPL/SWITCH/CHILLER.connectedDevices.guideAlarmNode
• LA1_LAS_PPL/SWITCH/CHILLER.connectedDevices.flowAlarmNode
• LA1_LAS_PPL/SWITCH/CHILLER.connectedDevices.allAlarmNode
• LA1_LAS_PPL/SWITCH/CHILLER.connectedDevices.waterAlarmNode
• LA1_LAS_PPL/SWITCH/CHILLER.connectedDevices.tempAlarmNode

AC_SPB_DIAG

projects:LA1_SPB_NOPA

• LA1_LAS_PPL/CTRL/AC_SPB_DIAG.pulseWidth
• LA1_LAS_PPL/CTRL/AC_SPB_DIAG.calibrate
• LA1_LAS_PPL/CTRL/AC_SPB_DIAG.useAsCalibrationImage2
• LA1_LAS_PPL/CTRL/AC_SPB_DIAG.xWidth3
• LA1_LAS_PPL/CTRL/AC_SPB_DIAG.useAsCalibrationImage1

SPB 2nd stage

projects:LA1_SPB_NOPA

• LA1_LAS_PPL/PROC/NOPA_SPB_2.x0,LA1_LAS_PPL/PROC/NOPA_SPB_2.y0
• LA1_LAS_PPL/PROC/NOPA_SPB_2.x01d,LA1_LAS_PPL/PROC/NOPA_SPB_2.y01d
• LA1_LAS_PPL/SPECT/NOPA_SPB_2.wavelengths,LA1_LAS_PPL/SPECT/NOPA_SPB_2.output.schema.data.spectrum,LA1_LAS_PPL/SPECT/NOPA_SPB_2.refSpectrum
• LA1_LAS_PPL/SPECT/NOPA_SPB_2.wavelengths,LA1_LAS_PPL/SPECT/NOPA_SPB_2.output.schema.data.spectrum

FXE 1st stage

projects:LA1_FXE_NOPA

• LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum,LA1_LAS_PPL/SPECT/NOPA_FXE_1.loadBkgSpectrum,LA1_LAS_PPL/SPECT/NOPA_FXE_1.refSpectrum
• LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum,LA1_LAS_PPL/SPECT/NOPA_FXE_1.loadBkgSpectrum
• Macro-ADC_DIAG_TRG-bd0920e2-0ab9-41c1-905f-b37f8ddca677-AdcDiagTrg.setDiagToUpstream
• LA1_LAS_PPL/PROC/NOPA_FXE_1.x0,LA1_LAS_PPL/PROC/NOPA_FXE_1.y0
• LA1_LAS_PPL/PROC/NOPA_FXE_1.x01d,LA1_LAS_PPL/PROC/NOPA_FXE_1.y01d

Timing changes 800nm

projects:Instrument Timing and Status

• LA1_LAS_PPL/CTRL/TRGDLY.triggerFE_SPB
• Macro-master_burst-fdd26510-4e37-4305-86de-96e68a97b92a-MasterBurst.Time_Left
• Macro-master_burst-fdd26510-4e37-4305-86de-96e68a97b92a-MasterBurst.Start
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OdlM_Dis
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OXC_En
• Macro-master_burst-fdd26510-4e37-4305-86de-96e68a97b92a-MasterBurst.Time_Rq
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.LSU_ODL_lock_position_steps
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Curr_LSU_ODL_lock_position_steps
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.def_state
• Macro-master_burst-fdd26510-4e37-4305-86de-96e68a97b92a-MasterBurst.Stop
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.RF_harmonic_phase_fs
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.AOM_OFF
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Stop
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SFB_State
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Timestamp
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Save
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SFB_Ref_RF_HARMONIC
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OXC_ODL_position_ps
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Timing_shifter_ps
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OdlM_En
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Restore
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.alive
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.ODL_status
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SFB_En
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Re_Lock_Status
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OXC_Dis
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SynchMode
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Curr_Timing_shifter_offset_ps
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.switching_status
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Save_Restore_Status
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.AOM_ON
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.train_id
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SFB_Ref_OXC
• Macro-finde_delay_FE-e2f689d4-786b-4f57-a579-e3e6387f16a8-FindeDelayFe.FineDelayMinus
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Clear
• Macro-master_burst-fdd26510-4e37-4305-86de-96e68a97b92a-MasterBurst.BurstLength
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SFB_Dis
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Timing_shifter_offset_ps
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.FB_Reference
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_SPBp
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.lSet
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OdlM_State
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.SFB_Status
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Curr_OXC_ODL_position_ps
• Macro-finde_delay_FE-e2f689d4-786b-4f57-a579-e3e6387f16a8-FindeDelayFe.FineDelayPlus
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OXC_signal_fs
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.Curr_Timing_shifter_ps
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.OXC_status
• Macro-ppl_synch-b65166cf-f82c-4684-b42d-0b1ae1fb754e-PplSynch.LOCK
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_FXEp
• LA1_LAS_PPL/CTRL/TRGDLY.triggerFE_FXE

FXE 3rd Stage

projects:LA1_FXE_NOPA

• LA1_LAS_PPL/PROC/NOPA_FXE_3.beamWidth1d,LA1_LAS_PPL/PROC/NOPA_FXE_3.beamHeight1d
• LA1_LAS_PPL/PROC/NOPA_FXE_3.x01d,LA1_LAS_PPL/PROC/NOPA_FXE_3.y01d

FE CTRL

projects:LA1_FE_CTRL

• LA1_LAS_PPL/CTRL/ONEFIVE_FE.connect

FXE user panel

projects:LA1_FXE_NOPA

• LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum
• LA1_LAS_PPL/PROC/NOPA_FXE_2.x01d,LA1_LAS_PPL/PROC/NOPA_FXE_2.y01d
• LA1_LAS_PPL/CTRL/TRGDLY.delayTsChange

LA1_LAS_PPL/MDL/CAM_WATCHDOG|default_scene

projects:LA1_DIAG

• LA1_LAS_PPL/MDL/CAM_WATCHDOG.maxAttempts
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.status
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.cameras
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.timeout
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.deviceId
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.state
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.reset

Laser_config

projects:Instrument Timing and Status

• LA1_LAS_PPL/CTRL/DIAGNOSTIC.laserError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.tunePCm
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.tunePCs
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.temperatureError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.FEError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.TEMError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.fxeBCCLockingError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.cmBCCError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.AmphosError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.humidityError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.opticalSynchError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.spbBCCLockingError
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.tuningInProgress
• LA1_LAS_PPL/CTRL/DIAGNOSTIC.state

x2Timer_trigger

projects:LA1_DIAG

• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.sRegDelay
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.sRegDelayCnt
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.lBoard
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.sRegDuration
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.writeDelay
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.readReg
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.lUnits
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.rDelay
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.writeDesc
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.wRelativeDuration
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.writeDuration
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.lReg
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.sRegDesc
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.wRelativeDelay
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.sRegDurationCnt
• Macro-xt2-5f496317-f3c9-4bf9-87a1-915e51931662-Xt.rWidth

TEM XF2 SPB-FXE

projects:LA1_TEM_XF2

• LA1_LAS_PPL/CTRL/TEM_XF2_FXE-SPB._connect_

test

projects:LA1_DAQ_RUN_MGMT_NEW

• LA1_LAS_PPL/CAM/AVE_FXE_Instr_2.daqOutput.schema.data.image
• LA1_LAS_PPL/CAM/AVE_FXE_Instr_2.output.schema.data.image
• Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF1_SPB

fxe_tune

projects:LA1_DIAG

• Macro-ADC_DIAG_TRG-bd0920e2-0ab9-41c1-905f-b37f8ddca677-AdcDiagTrg.setDiagToUpstream
• Macro-ADC_DIAG_TRG-bd0920e2-0ab9-41c1-905f-b37f8ddca677-AdcDiagTrg.setDiagToDownstream
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_FXEp
• Macro-adc_proc_fxe-50f438f1-deb7-4d1c-8a2a-dbe430b94411-AdcProcFXE.PD_XF1_FXE,Macro-adc_proc_fxe-50f438f1-deb7-4d1c-8a2a-dbe430b94411-AdcProcFXE.PD_NOPA1_FXE,Macro-adc_proc_fxe-50f438f1-deb7-4d1c-8a2a-dbe430b94411-AdcProcFXE.PD_1030_FXE,Macro-adc_proc_fxe-50f438f1-deb7-4d1c-8a2a-dbe430b94411-AdcProcFXE.PD_XF2,Macro-adc_proc_fxe-50f438f1-deb7-4d1c-8a2a-dbe430b94411-AdcProcFXE.PD_XF2_p

spb_tune

projects:LA1_DIAG

• Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.Start
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_SPBp
• Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF1_SPB,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_NOPA1_SPB,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_1030_SPB,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF2
• Macro-ADC_DIAG_TRG-bd0920e2-0ab9-41c1-905f-b37f8ddca677-AdcDiagTrg.setDiagToUpstream
• Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.Stop
• Macro-ADC_DIAG_TRG-bd0920e2-0ab9-41c1-905f-b37f8ddca677-AdcDiagTrg.setDiagToDownstream
• Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF1_SPB,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_NOPA1_SPB,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_1030_SPB,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF2,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF2_p,Macro-adc_proc_spb-c1437ce1-9a1f-4648-985f-ed78d55b8cd2-AdcProcSPB.PD_XF2_pp

old__PC-and-AOM-settings

projects:LA1_LAS_TIMING

• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mAOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_off
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_off
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.M_AOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sAOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_on
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.S_AOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_on

LA1_RUN_CONTROL_1

projects:LA1_DAQ_RUN_MGMT

• LA1_DAQ_DATA/DM/RUN_CONTROL_2.runNumber
• LA1_DAQ_DATA/DM/CONFIGURATOR_2.configurations
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.actions.proposal
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.sample
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.actions.configure
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.monitor
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.experiment
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.actions.assign
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.proposalNumber
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.actions.dataSource
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.dataSourceToAggregatorsMapping
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.state
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.actions.monitor
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.ignore
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.tune
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.runMsg
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.configure
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.lastStatusMessage
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.slotPushToDaq
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.actions.topology
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.record
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.trainId
• LA1_DAQ_DATA/DM/RUN_CONTROL_2.slotRetrieveProposalDetails

CHECK_COFIGURATION_GROUPS

projects:LA1_CHECK_CONFIG_GROUPS

• LA1_DAQ_DATA/DM/checkConfigGroups.scanGroupsResult
• LA1_DAQ_DATA/DM/checkConfigGroups.checkConfigruationGroup
• LA1_DAQ_DATA/DM/checkConfigGroups.selectAllGroups
• LA1_DAQ_DATA/DM/checkConfigGroups.recentTrainId
• LA1_DAQ_DATA/DM/checkConfigGroups.state
• LA1_DAQ_DATA/DM/checkConfigGroups.start
• LA1_DAQ_DATA/DM/checkConfigGroups.availableGroups
• LA1_DAQ_DATA/DM/checkConfigGroups.statusMessage
• LA1_DAQ_DATA/DM/checkConfigGroups.deselectAllGroups

EMAIL_COFIGURATION_GROUPS

projects:LA1_CHECK_CONFIG_GROUPS

• LA1_DAQ_DATA/DM/checkConfigGroups.availableGroups
• LA1_DAQ_DATA/DM/checkConfigGroups.statusMessage
• LA1_DAQ_DATA/DM/checkConfigGroups.state
• LA1_DAQ_DATA/DM/checkConfigGroups.start

CAM_STATUS

projects:LA1_DIAG

• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.CAM_Solve_All_in_ErrorList
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.CAM_STOP_ACQUIRE
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.state
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.camAllList
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.CAM_in_Error
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.CAM_all_State
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.camErrorList
• Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.ALL_CAM_STOP_ACQUIRE

FXE 1030 Beam

projects:1030 Output Beam

• LA1_LAS_PPL/CAM/FXE_1030.acquire,LA1_LAS_PPL/CAM/FXE_1030.stop

TEM XF2 SPB-FXE incl setpoints0

projects:LA1_TEM_XF2

• LA1_LAS_PPL/CTRL/TEM_XF2_FXE-SPB._connect_
• LA1_LAS_PPL/CAM/NOPA_SPB_SEED.stop
• LA1_LAS_PPL/PROC/NOPA_SPB_SEED.x01d
• LA1_LAS_PPL/PROC/NOPA_FXE_SEED.y01d
• LA1_LAS_PPL/CAM/NOPA_FXE_SEED.stop
• LA1_LAS_PPL/CAM/NOPA_FXE_SEED.acquire
• LA1_LAS_PPL/PROC/NOPA_SPB_SEED.y01d
• LA1_LAS_PPL/CAM/NOPA_SPB_SEED.acquire
• LA1_LAS_PPL/PROC/NOPA_FXE_SEED.inFrameRate
• LA1_LAS_PPL/CAM/NOPA_SPB_SEED.frameRate.actual
• LA1_LAS_PPL/PROC/NOPA_FXE_SEED.x01d

LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW|View All Patterns

projects:LA1_PPL_PATTERN

• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_FXE.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_FXE.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SASE2.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SASE2.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SQS.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SQS.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SPB.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SPB.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SCS.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SCS.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_15.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_15.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS2.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS2.pplPattern
• LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS1.bunchCharge,LA1_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS1.pplPattern

SPB_SPECTUNING

projects:Instrument Timing and Status

• LA1_LAS_PPL/SPECT/NOPA_SPB_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_SPB_1.output.schema.data.spectrum
• LA1_LAS_PPL/SPECT/NOPA_SPB_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_SPB_1.output.schema.data.spectrum,LA1_LAS_PPL/SPECT/NOPA_SPB_1.refSpectrum

LA1_DAQ_DATA/DM/LAS_20Hz_GROUP|scene

projects:LA1_CONFIG_GROUPS

• LA1_DAQ_DATA/DM/LAS_20Hz_GROUP.group.user
• LA1_DAQ_DATA/DM/LAS_20Hz_GROUP.group.description
• LA1_DAQ_DATA/DM/LAS_20Hz_GROUP.group.expert
• LA1_DAQ_DATA/DM/LAS_20Hz_GROUP.group.id
• LA1_DAQ_DATA/DM/LAS_20Hz_GROUP.group.saveGroupConfiguration

GetPplFIrstPeak

projects:LA1_LAS_TIMING

• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.maxDeviation
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.positionState
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.cancel
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.reset
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.state
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.peakPos
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.execute
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.data
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.isPositionOk

Status

projects:LA1_DIAG

• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.alive
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_SPBp
• Macro-LP_read-0687239c-e409-4472-a049-97589d342497-LpRead.LP_FXEp
• LA1_LAS_PPL/SPECT/NOPA_SPB_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_SPB_1.output.schema.data.spectrum
• LA1_LAS_PPL/MDL/CAM_WATCHDOG.state
• LA1_LAS_PPL/SPECT/NOPA_FXE_1.wavelengths,LA1_LAS_PPL/SPECT/NOPA_FXE_1.output.schema.data.spectrum
• Macro-GetPplFirstPeakPosition-af5cd2c9-144d-448e-9200-5fb93c4041a7-GetPplFirstPeakPosition.isPositionOk

LA1_LAS_PPL/CTRL/AC_XF2_DIAG|scene

projects:LA1_DIAG

• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.pulseWidth
• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.fitStatus
• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.xMinFit
• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.output.schema.data.integralX,LA1_LAS_PPL/CTRL/AC_XF2_DIAG.output.schema.data.integralXFit
• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.ePulseWidth
• LA1_LAS_PPL/CAM/AC_XF2_DIAG.availableScenes
• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.xMaxFit
• LA1_LAS_PPL/CTRL/AC_XF2_DIAG.subtractPedestal

FXE 1030 Status Scene

projects:Instrument Timing and Status

• LA1_LAS_PPL/PROC/FXE_UNCOMP.x01d,LA1_LAS_PPL/PROC/FXE_UNCOMP.y01d
• LA1_LAS_PPL/PROC/FXE_UNCOMP.beamHeight1d,LA1_LAS_PPL/PROC/FXE_UNCOMP.beamWidth1d

LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE|overview

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.cameras.camera_0.device
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.instrument
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_0.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_3.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.isOk
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_1.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_2.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_3.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.cameras.camera_0.signalThreshold
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_1.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_3.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_0.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.availableScenes
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_2.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_1.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.activeLaserOpMode
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_1.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.cameras.camera_0.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_2.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.currentExperiment
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.outputs.output_3.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_2.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.status

LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB|overview

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.currentExperiment
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_3.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_0.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_1.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_2.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_0.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.instrument
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_3.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_3.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_1.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_0.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_1.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_2.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_3.beamConfig
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_2.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.isOk
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.outputs.output_2.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.status
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_1.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.cameras.camera_0.signalThreshold
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.waveplates.waveplate_0.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.availableScenes
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.cameras.camera_0.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.activeLaserOpMode
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.cameras.camera_0.device

LA1_LAS_PPL/MDL/PPL_OVERVIEW|overview

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/PPL_OVERVIEW.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.instrument
• LA1_LAS_PPL/MDL/FE_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.isOk
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/PPL_OVERVIEW.start
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.instrument
• LA1_LAS_PPL/MDL/PPL_OVERVIEW.beamline
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/PPL_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.availableScenes
• LA1_LAS_PPL/MDL/PPL_OVERVIEW.stop
• LA1_LAS_PPL/MDL/FE_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/PPL_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.isOk
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.cameras.camera_0.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.availableScenes
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_SPB.cameras.camera_0.state
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/PPL_OVERVIEW.status

LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE|waveplate_0

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.outputs.reflectionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.instrument
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.outputs.transmissionLine.state
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.nominalPositionTransmission
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.alias
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.nominalPositionReflection
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.device
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.positionRange
• LA1_LAS_PPL/MDL/NOPA_AMP_OVERVIEW_FXE.waveplates.waveplate_0.inputs

LPoD

projects:LA1_PPL_PATTERN

• LA1_LAS_PPL/MDL/PATTERN_CTRL.incStartTrainID
• LA1_LAS_PPL/MDL/PATTERN_CTRL.actualTrainID
• LA1_LAS_PPL/MDL/PATTERN_CTRL.seriesNumberEnd
• LA1_LAS_PPL/MDL/PATTERN_CTRL.setPulsePattern
• LA1_LAS_PPL/MDL/PATTERN_CTRL.dispLeftTrainID
• LA1_LAS_PPL/MDL/PATTERN_CTRL.enableAllPulses
• LA1_LAS_PPL/MDL/PATTERN_CTRL.startCommand
• LA1_LAS_PPL/MDL/PATTERN_CTRL.seriesNumber
• LA1_LAS_PPL/MDL/PATTERN_CTRL.timeToCmdExe
• LA1_LAS_PPL/MDL/PATTERN_CTRL.incrementStartTrainID
• LA1_LAS_PPL/MDL/PATTERN_CTRL.leftTime
• LA1_LAS_PPL/MDL/PATTERN_CTRL.disableAllPulses
• LA1_LAS_PPL/MDL/PATTERN_CTRL.leftTrainIDToExe
• LA1_LAS_PPL/MDL/PATTERN_CTRL.startTrainID
• LA1_LAS_PPL/MDL/PATTERN_CTRL.cancelCommand
• LA1_LAS_PPL/MDL/PATTERN_CTRL.setActiveLP
• LA1_LAS_PPL/MDL/PATTERN_CTRL.cmdStatus

LP_monitor

projects:LA1_PPL_PATTERN

• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.TLP_Data
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.l_LP
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.leftTime
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.ref_time
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.Start
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.Init
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.Stop
• Macro-lp_monitor-fdf5f996-6e46-4198-957a-1b3185a4cb30-LpMonitor.Clear

LPoDDiag

projects:LA1_PPL_PATTERN

• LA1_LAS_PPL/MDL/PATTERN_CTRL.LPServerData
• LA1_LAS_PPL/MDL/PATTERN_CTRL.readLPServerData
• LA1_LAS_PPL/MDL/PATTERN_CTRL.cmdString

LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST|default

projects:LA1_LAS_ADC

• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pedestalEntries
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.noise
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.adcChannel
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pedestal
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.thresholdFactor
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.maxDeviation
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.adcDevice
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.updateInterval
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.status
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pulseDelayDev
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.pollInterval
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.isPositionOk
• LA1_LAS_PPL/MDL/ADC_PEAKPOS_TEST.peakPos

LA1_LAS_PPL/MDL/GALVO_OVERVIEW|overview

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.isGalvoVoltageOk
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.beamline
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.isGalvoTemperatureOk
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.pcTriggerChannel
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.pockelsCellState
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.pcDoocsServer
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.galvo
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.pockelsCellOutput
• LA1_LAS_PPL/MDL/GALVO_OVERVIEW.isPockelsCellOk

TEM-XF1

projects:LA1_TEM

• LA1_LAS_PPL/CTRL/TEM_XF1._connect_

TEM-XF2-FXE-SPB

projects:LA1_TEM

• LA1_LAS_PPL/CTRL/TEM_XF2_FXE-SPB._connect_

LA1_LAS_PPL/MDL/USER_STARTER|generate_scene

projects:LA1_LAS_USERSTARTER

• LA1_LAS_PPL/MDL/USER_STARTER.startMissing

FXE_SEED

projects:LA1_XF2_DIAGNOSTICS

• LA1_LAS_PPL/PROC/FXE_SEED.x0,LA1_LAS_PPL/PROC/FXE_SEED.x01d
• LA1_LAS_PPL/PROC/FXE_SEED.y0,LA1_LAS_PPL/PROC/FXE_SEED.y01d

LA1_LAS_PPL/MDL/USER_STARTER_Sans_Serif110

projects:LA1_LAS_USERSTARTER

• LA1_LAS_PPL/MDL/USER_STARTER.startMissing

FXE_ILH_PPL/CAM/REF_POS2|scene

projects:LA1_PROXY

• FXE_ILH_PPL/CAM/REF_POS2.trigger
• FXE_ILH_PPL/CAM/REF_POS2.acquire
• FXE_ILH_PPL/CAM/REF_POS2.stop
• FXE_ILH_PPL/CAM/REF_POS2.reset

MOT_BEAM_TEST

projects:LA1_MIRRORS_CTRL

• c.targetPosition
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.actualPosition
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Move
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.listMotor
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Calibrate
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.ResetAllErrors
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Home
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.motorId
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.all_ON
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Down
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Status
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Off
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Up
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.all_OFF
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.selectMotor
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.GetTraget
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.targetPosition
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.Stop
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.CalibrateAll
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.WriteParams
• Macro-mot_beam_prop-456e6a64-fda8-4ceb-8051-3bd528bf2f2d-MotBeamProp.On

SPB_NOPA_BEAM_POS

projects:Instrument Timing and Status

• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2v_p100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_V_Down.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1h_p100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorV_pos
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1V_Status.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_V_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1H_Status
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_n100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_p100
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_V_Up
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_H_Up
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2v_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2h_p10.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2v_p10
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_motorH_pos
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1v_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2v_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_motorH_pos
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.exp
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2h_n100.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_motorH_limit
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_V_Up
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2H_Status.
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_p10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1h_n10.
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.exp
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1v_n100.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1V_Status
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1h_p10
• SPB_LAS_LCD-2/PROC/800NM_1.x0,SPB_LAS_LCD-2/PROC/800NM_1.y0
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_motorH_limit.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1v_p10.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_V_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1h_n100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_motorV_limit.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1h_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1v_p10
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_motorV_pos
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_motorH_limit.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_H_Up.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_H_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_H_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_motorH_pos
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2v_p10.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_H_Up
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2v_n10.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_H_Down.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_motorV_pos
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1H_Status
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_motorH_pos.
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorH_pos
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1v_p100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_motorH_limit
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorH_limit
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_motorV_pos
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlexp.
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_p100
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_V_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_motorH_limit
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2V_Status.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1v_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_H_Down
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_n10
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1h_p10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1v_n100
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2v_p100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2v_n100.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_H_Down.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2H_Status
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_V_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1v_n100
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_motorV_limit
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_motorH_limit
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1V_Status
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2v_p100.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_V_Up.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2v_n100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_V_Down
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2h_p100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_V_Up.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_V_Down.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_V_Up
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1h_n10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_n100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2h_p100.
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_n10
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2h_n100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1v_p100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_H_Up.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_V_Up
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_H_Down
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2h_p10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_p10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1h_p100.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1h_n100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2V_Status
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1V_Status
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2h_p100
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2V_Status
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2H_Status
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1h_p10.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2v_p10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1v_n10.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2h_p10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_motorV_pos.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_motorV_limit
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2h_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2h_n100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1_motorV_limit.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_motorV_pos.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2v_n100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1H_Status
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1h_n100.
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1v_p10
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L2_H_Up
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_H_Down
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1H_Status.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_motorH_pos
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_motorV_pos
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1_motorV_limit
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_V_Up
• Macro-beamCtrl-a5cfb105-d093-41be-8066-a13c176ee590-Beamctrl.L1h_p100
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L1_H_Up
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.exp
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2h_n10
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2h_n10.
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL2_motorH_pos.
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorV_limit
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_H_Up
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrl.L2_motorV_limit
• Macro-SPB_beamCtrl-5ed071b9-7604-43d7-9c64-4a9969721232-SPBBeamctrlL1v_p100.

FXE_NOPA_BEAM_POS_ALL

projects:LA1_MIRRORS_CTRL

• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2H_Status
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1H_Status
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_p10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorH_limit
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.Calibrate
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2v_n100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_motorV_pos
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_p10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_motorV_limit
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_V_Up
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1V_Status
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2v_n10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2h_p10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_H_Down
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2v_p100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorH_pos
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.exp
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_n10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2V_Status
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2h_n100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_V_Up
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorV_pos
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_p100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorV_limit
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2v_p10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_H_Up
• FXE_ILH_PPL/PROC/REF_POS2.x0,FXE_ILH_PPL/PROC/REF_POS2.y0
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_motorH_limit
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_V_Down
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_n10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_n100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_p100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_V_Down
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.all_ON
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_H_Down
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_motorH_pos
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2h_p100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_n100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2_H_Up
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.all_OFF
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L2h_n10

FXE_NOPA_BEAM_POS

projects:Instrument Timing and Status

• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_p100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorV_pos
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1H_Status
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_p10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_n10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorH_limit
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_p100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_n100
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1v_n10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.exp
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_H_Down
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorH_pos
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_motorV_limit
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_p10
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1h_n100
• FXE_ILH_PPL/PROC/REF_POS2.x0,FXE_ILH_PPL/PROC/REF_POS2.y0
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_H_Up
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_V_Up
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1V_Status
• Macro-FXE_beamCtrl-f86030d3-dda2-4727-9a0d-b0dc7d630811-FXEBeamctrl.L1_V_Down

SPB_NOPA_BEAM_POS_ALL

projects:LA1_MIRRORS_CTRL

• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.Calibrate
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorV_pos
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_H_Down
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2h_n100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_motorH_limit
• SPB_LAS_LCD-2/PROC/800NM_1.x0,SPB_LAS_LCD-2/PROC/800NM_1.y0
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2h_p10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.all_OFF
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2v_n100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_motorH_pos
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_n100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_p100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_V_Down
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2v_p10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2v_p100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_motorV_limit
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_n100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2h_p100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2h_n10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2V_Status
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_motorV_pos
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_n10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_V_Up
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_H_Down
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1H_Status
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_V_Down
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_p10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_H_Up
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorH_pos
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorH_limit
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2v_n10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1V_Status
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_motorV_limit
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2H_Status
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1_H_Up
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.all_ON
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_p100
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1v_p10
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.exp
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L2_V_Up
• Macro-SPB_beamCtrl-7fddbb3b-3b2a-4150-bd62-e13eb7479ac6-SPBBeamctrl.L1h_n10

LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW|layout

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isOutputsOk
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isDriftOk
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.outputs.state
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.inputs.state
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isInputsOk
• LA1_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isTemOk

LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW|layout

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.inputs.state
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.isDriftOk
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.isTemOk
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.outputs.state
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.isInputsOk
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/TEM_XF2_FXE_OVERVIEW.isOutputsOk

LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW|layout

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.isOutputsOk
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.isTemOk
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.isDriftOk
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.outputs.state
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.isInputsOk
• LA1_LAS_PPL/MDL/TEM_XF2_SPB_OVERVIEW.inputs.state

LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW|layout

projects:LA1_PPL_OVERVIEW

• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.isOk
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.outputs.state
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.inputs.state
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.isInputsOk
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.availableScenes
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.isAmphosOk
• LA1_LAS_PPL/MDL/AMPHOS_OVERVIEW.isOutputsOk

TEST

projects:LA1_DIAG

• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdNopa1.peakPos

test2

projects:LA1_DIAG

• LA1_LAS_PPL/ADQ/1.board4.sizeOfTransferBuffer
• LA1_LAS_PPL/ADQ/1.board2.raw.sampleMicrosecs
• LA1_LAS_PPL/ADQ/1.board4.hasTrainId
• LA1_LAS_PPL/ADQ/1.board3.temperature.sensor3
• LA1_LAS_PPL/ADQ/1.board3.hasTrigger
• LA1_LAS_PPL/ADQ/1.board3.enable_zero
• LA1_LAS_PPL/ADQ/1.board4.enable_raw
• LA1_LAS_PPL/ADQ/1.board2.temperature.sensor2
• LA1_LAS_PPL/ADQ/1.board2.streamDataSize
• LA1_LAS_PPL/ADQ/1.board3.temperature.sensor2
• LA1_LAS_PPL/ADQ/1.board2.temperature.sensor0
• LA1_LAS_PPL/ADQ/1.board3.trigger_counter
• LA1_LAS_PPL/ADQ/1.board4.temperature.sensor0
• LA1_LAS_PPL/ADQ/1.board2.enable_apd
• LA1_LAS_PPL/ADQ/1.board3.enable_apd
• LA1_LAS_PPL/ADQ/1.board4.enable_peak
• LA1_LAS_PPL/ADQ/1.board4.hasTrigger
• LA1_LAS_PPL/ADQ/1.board2.sizeOfTransferBuffer
• LA1_LAS_PPL/ADQ/1.board2.hasTrigger
• LA1_LAS_PPL/ADQ/1.board2.trigger_counter
• LA1_LAS_PPL/ADQ/1.board3.hasTrainId
• LA1_LAS_PPL/ADQ/1.board3.raw.samples
• LA1_LAS_PPL/ADQ/1.board4.numberOfTransferBuffers
• LA1_LAS_PPL/ADQ/1.board4.enable_apd
• LA1_LAS_PPL/ADQ/1.board3.hasClock
• LA1_LAS_PPL/ADQ/1.board3.raw.sampleMicrosecs
• LA1_LAS_PPL/ADQ/1.board3.temperature.sensor0
• LA1_LAS_PPL/ADQ/1.board4.temperature.sensor4
• LA1_LAS_PPL/ADQ/1.board4.enable
• LA1_LAS_PPL/ADQ/1.board3.streamDataSize
• LA1_LAS_PPL/ADQ/1.board4.temperature.sensor2
• LA1_LAS_PPL/ADQ/1.board4.trigger_counter
• LA1_LAS_PPL/ADQ/1.board2.hasClock
• LA1_LAS_PPL/ADQ/1.board3.temperature.sensor4
• LA1_LAS_PPL/ADQ/1.board4.temperature.sensor1
• LA1_LAS_PPL/ADQ/1.board2.raw.samples
• LA1_LAS_PPL/ADQ/1.board2.hasTrainId
• LA1_LAS_PPL/ADQ/1.board3.sizeOfTransferBuffer
• LA1_LAS_PPL/ADQ/1.board4.streamDataSize
• LA1_LAS_PPL/ADQ/1.board3.temperature.sensor1
• LA1_LAS_PPL/ADQ/1.board2.enable_raw
• LA1_LAS_PPL/ADQ/1.board3.enable
• LA1_LAS_PPL/ADQ/1.board3.enable_peak
• LA1_LAS_PPL/ADQ/1.board2.enable_peak
• LA1_LAS_PPL/ADQ/1.board2.temperature.sensor1
• LA1_LAS_PPL/ADQ/1.board2.enable
• LA1_LAS_PPL/ADQ/1.board2.numberOfTransferBuffers
• LA1_LAS_PPL/ADQ/1.board4.enable_zero
• LA1_LAS_PPL/ADQ/1.board2.temperature.sensor4
• LA1_LAS_PPL/ADQ/1.board4.hasClock
• LA1_LAS_PPL/ADQ/1.board3.numberOfTransferBuffers
• LA1_LAS_PPL/ADQ/1.board2.temperature.sensor3
• LA1_LAS_PPL/ADQ/1.board4.temperature.sensor3
• LA1_LAS_PPL/ADQ/1.board2.enable_zero
• LA1_LAS_PPL/ADQ/1.board4.raw.samples
• LA1_LAS_PPL/ADQ/1.board3.enable_raw
• LA1_LAS_PPL/ADQ/1.board4.raw.sampleMicrosecs

GentecTest

projects:LA1_TEST

• LA1_LAS_PPL/ASENS/EMETER_GENTEC_TEST.output.schema.energy1.energy

ADQ14

projects:LA1_DIAG

• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.dev_status
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_100
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.writeDelay_t
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_1000
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_50ms
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_10
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.sRegDelayCnt
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.lUnits
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_50ms
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_100
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.newDelay
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_10000
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_10000
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_1
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.newDelay_t
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.readReg
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.sRegDelay
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.INIT
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_1
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_1000
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.writeDelay
• Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_10

PC-and-AOM-settings

projects:LA1_LAS_TIMING

• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.def_state
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.Pockels_Cell_Off
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mAOM_inv
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.AOM_OFF
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_off
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_off
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.Pockels_Cell_On
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.AOM_ON
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.M_AOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sAOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_on
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.S_AOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_on

WorkInHutch

projects:LA1_LAS_TIMING

• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.work_start
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.def_state
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.user_name
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mAOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_off
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_off
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.workEn
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.M_AOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sAOM_inv
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.user_phone
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.S_AOM_inv
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_on
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.WorkStart
• Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_on
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.user_error
• Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.WorkEnd

FXE_1030nm_BEAM_POS_ALL

projects:Instrument Timing and Status

• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_H_Up
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1V_Status
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_V_Up
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2v_p10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.Calibrate
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_motorH_pos
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2v_p100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_motorH_limit
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_motorV_limit
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_H_Down
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2v_n100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2h_n100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_V_Down
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.all_ON
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2V_Status
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1h_n10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_motorV_pos
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2h_p10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1H_Status
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1h_n100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1h_p10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_motorH_limit
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1v_p100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2h_p100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_motorH_pos
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1v_n10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_V_Down
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_V_Up
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1h_p100
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_H_Down
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2v_n10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2h_n10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.exp
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1v_p10
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_motorV_pos
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.all_OFF
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2H_Status
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1_H_Up
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L2_motorV_limit
• Macro-FXE_uncomp_beamCtrl-660f8c5c-fcb4-4a6e-9e7d-c464c4f8f150-FXEUncompBeamctrl.L1v_n100

SPB_1030nm_BEAM_POS_ALL

projects:Instrument Timing and Status

• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1V_Status
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_H_Down
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2h_p10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_motorH_pos
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2V_Status
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_H_Up
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_motorH_limit
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2h_n10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1h_p10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2h_n100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1h_n10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.all_OFF
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_motorV_limit
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_motorH_pos
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_motorV_pos
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_motorV_pos
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_V_Up
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.Calibrate
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1v_p100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_V_Down
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_motorV_limit
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2H_Status
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1v_n100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.exp
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_H_Up
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1h_n100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.all_ON
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1h_p100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2h_p100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_motorH_limit
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2v_n100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1_V_Up
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1v_p10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_H_Down
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2_V_Down
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1H_Status
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2v_n10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2v_p10
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L2v_p100
• Macro-SPB_uncomp_beamCtrl-22bc0d91-a31b-45c3-a7da-18146bf67b8a-SPBUncompBeamctrl.L1v_n10

BEAM_TEST

projects:BeamProcessor-Test

• LA1_LAS_PPL/PROC/BEAM_TEST.regionIntegral
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.rawX,LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.processedX
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.rawY,LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.processedY
• LA1_LAS_PPL/PROC/BEAM_TEST.output.schema.data.image
• LA1_LAS_PPL/PROC/BEAM_TEST.x0
• LA1_LAS_PPL/PROC/BEAM_TEST.y0

FE_XF_FFnew

projects:BeamProcessor-Test

• LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.rawX,LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.processedX,LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.rawY,LA1_LAS_PPL/PROC/FE_XF1_FFnew.beamProfile.processedY
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.y0
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.output.schema.data.image
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.x0
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.theta2d
• LA1_LAS_PPL/PROC/FE_XF1_FFnew.regionIntegral

SPB_LAS_LCD-2/PROC/800NM_1

projects:LA1_PROXY

• SPB_LAS_LCD-2/PROC/800NM_1.output.schema.data.imgY
• SPB_LAS_LCD-2/PROC/800NM_1.x01d
• SPB_LAS_LCD-2/PROC/800NM_1.y01d
• SPB_LAS_LCD-2/PROC/800NM_1.output.schema.data.imgX
• SPB_LAS_LCD-2/PROC/800NM_1.x0,SPB_LAS_LCD-2/PROC/800NM_1.y0
• SPB_LAS_LCD-2/PROC/800NM_1.regionIntegral

AMPHOS_burst_shape

projects:LA1_LAS_TIMING

• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.status
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.getDelay
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.stepSize
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.slaveDelayTime
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.stepDown
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.slaveDelayCounts
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.masterDelayTime
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.masterDelayCounts
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.selection
• Macro-burstShapeAmphos-bd6627ec-a48c-44d8-9bba-fc29e7ec802c-burstShapeAmphos.stepUp

LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE|scene

projects:LA1_DIAG

• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.exp
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.deviceId
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdNopa1.label
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pd1030.label
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pd1030.deviation
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.refChannel
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdXf2.deviation
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdXf2.label
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdNopa1.deviation
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdXf1.deviation
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.interval
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.pdXf1.label
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.state
• LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.output.schema.data.pdXf1,LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.output.schema.data.pdNopa1,LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.output.schema.data.pd1030,LA1_LAS_PPL/MDL/SYNCH_OVERVIEW_FXE.output.schema.data.pdXf2